Skip to content
v2.276.0

ActionProps Struct ​

Properties for the Action construct.

Example ​

ts
declare const fn: lambda.Function;

new appconfig.Extension(this, 'MyExtension', {
  actions: [
    new appconfig.Action({
      actionPoints: [appconfig.ActionPoint.ON_DEPLOYMENT_START],
      eventDestination: new appconfig.LambdaDestination(fn),
    }),
  ],
});
python
# fn: lambda.Function


appconfig.Extension(self, "MyExtension",
    actions=[
        appconfig.Action(
            action_points=[appconfig.ActionPoint.ON_DEPLOYMENT_START],
            event_destination=appconfig.LambdaDestination(fn)
        )
    ]
)
java
Function fn;


Extension.Builder.create(this, "MyExtension")
        .actions(List.of(
            Action.Builder.create()
                    .actionPoints(List.of(ActionPoint.ON_DEPLOYMENT_START))
                    .eventDestination(new LambdaDestination(fn))
                    .build()))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
Function fn;


new Extension(this, "MyExtension", new ExtensionProps {
    Actions = new [] {
        new Action(new ActionProps {
            ActionPoints = new [] { ActionPoint.ON_DEPLOYMENT_START },
            EventDestination = new LambdaDestination(fn)
        }) }
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var fn Function


appconfig.NewExtension(this, jsii.String("MyExtension"), &ExtensionProps{
	Actions: []Action{
		appconfig.NewAction(&ActionProps{
			ActionPoints: []ActionPoint{
				appconfig.ActionPoint_ON_DEPLOYMENT_START,
			},
			EventDestination: appconfig.NewLambdaDestination(fn),
		}),
	},
})

Properties ​

actionPointsActionPoint[]action_pointstyping.List[ActionPoint]actionPointsList<ActionPoint>ActionPointsActionPoint[]ActionPoints*[]ActionPointrequired#
The action points that will trigger the extension action.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
The description for the action.

Default: No description.

eventDestinationIEventDestinationevent_destinationIEventDestinationeventDestinationIEventDestinationEventDestinationIEventDestinationEventDestinationIEventDestinationrequired#
The event destination for the action.
executionRoleoptionalIRoleexecution_roleoptionalIRoleexecutionRoleoptionalIRoleExecutionRoleoptionalIRoleExecutionRoleoptionalIRole#
The execution role for the action.

Default: A role is generated.

invokeWithoutExecutionRoleoptionalbooleaninvoke_without_execution_roleoptionalboolinvokeWithoutExecutionRoleoptionalBooleanInvokeWithoutExecutionRoleoptionalboolInvokeWithoutExecutionRoleoptional*bool= false#
The flag that specifies whether or not to create the execution role.

If set to true, then the role will not be auto-generated under the assumption there is already the corresponding resource-based policy attached to the event destination. If false, the execution role will be generated if not provided.

nameoptionalstringnameoptionalstrnameoptionalStringNameoptionalstringNameoptional*string#
The name for the action.

Default: A name is generated.