software.amazon.awscdk.triggers

Class TriggerFunction

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.lambda.FunctionBase

software.amazon.awscdk.services.lambda.Function

software.amazon.awscdk.triggers.TriggerFunction

All Implemented Interfaces:

IDependable, IResource, software.amazon.awscdk.services.ec2.IClientVpnConnectionHandler, software.amazon.awscdk.services.ec2.IConnectable, software.amazon.awscdk.services.iam.IGrantable, IFunction, ITrigger, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-02T14:17:21.741Z")
 @Stability(value=Stable)
public class TriggerFunction
extends Function
implements ITrigger

Invokes an AWS Lambda function during deployment.

Example:

 import software.amazon.awscdk.services.lambda.*;
 import software.amazon.awscdk.triggers.*;
 import software.amazon.awscdk.core.Stack;
 Stack stack;
 TriggerFunction.Builder.create(stack, "MyTrigger")
         .runtime(Runtime.NODEJS_14_X)
         .handler("index.handler")
         .code(Code.fromAsset(__dirname + "/my-trigger"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TriggerFunction.Builder A fluent builder for TriggerFunction.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.triggers.ITrigger

ITrigger.Jsii$Default, ITrigger.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.lambda.IFunction

IFunction.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ec2.IClientVpnConnectionHandler

software.amazon.awscdk.services.ec2.IClientVpnConnectionHandler.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor and Description
	TriggerFunction(software.constructs.Construct scope, String id, TriggerFunctionProps props)
protected	TriggerFunction(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	TriggerFunction(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
void	executeAfter(software.constructs.Construct... scopes) Adds trigger dependencies.
void	executeBefore(software.constructs.Construct... scopes) Adds this trigger as a dependency on other constructs.
Trigger	getTrigger() The underlying trigger resource.

Methods inherited from class software.amazon.awscdk.services.lambda.Function

addAlias, addAlias, addEnvironment, addEnvironment, addLayers, addVersion, addVersion, addVersion, addVersion, addVersion, classifyVersionProperty, fromFunctionArn, fromFunctionAttributes, fromFunctionName, getArchitecture, getCanCreatePermissions, getCurrentVersion, getDeadLetterQueue, getDeadLetterTopic, getFunctionArn, getFunctionName, getGrantPrincipal, getLogGroup, getPermissionsNode, getResourceArnsForGrantInvoke, getRole, getRuntime, getTimeout, metricAll, metricAll, metricAllConcurrentExecutions, metricAllConcurrentExecutions, metricAllDuration, metricAllDuration, metricAllErrors, metricAllErrors, metricAllInvocations, metricAllInvocations, metricAllThrottles, metricAllThrottles, metricAllUnreservedConcurrentExecutions, metricAllUnreservedConcurrentExecutions

Methods inherited from class software.amazon.awscdk.services.lambda.FunctionBase

addEventSource, addEventSourceMapping, addFunctionUrl, addFunctionUrl, addPermission, addToRolePolicy, configureAsyncInvoke, considerWarningOnInvokeFunctionPermissions, getConnections, getIsBoundToVpc, getLatestVersion, grantInvoke, grantInvokeUrl, metric, metric, metricDuration, metricDuration, metricErrors, metricErrors, metricInvocations, metricInvocations, metricThrottles, metricThrottles, warnInvokeFunctionPermissions

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.constructs.Construct

toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Constructor Detail

TriggerFunction

protected TriggerFunction(software.amazon.jsii.JsiiObjectRef objRef)

TriggerFunction

protected TriggerFunction(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

TriggerFunction

@Stability(value=Stable)
public TriggerFunction(@NotNull
                                                software.constructs.Construct scope,
                                                @NotNull
                                                String id,
                                                @NotNull
                                                TriggerFunctionProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

executeAfter

@Stability(value=Stable)
public void executeAfter(@NotNull
                                                  software.constructs.Construct... scopes)

Adds trigger dependencies.

Execute this trigger only after these construct scopes have been provisioned.

Specified by:

executeAfter in interface ITrigger

Parameters:

scopes - This parameter is required.

executeBefore

@Stability(value=Stable)
public void executeBefore(@NotNull
                                                   software.constructs.Construct... scopes)

Adds this trigger as a dependency on other constructs.

This means that this trigger will get executed before the given construct(s).

Specified by:

executeBefore in interface ITrigger

Parameters:

scopes - This parameter is required.

getTrigger

@Stability(value=Stable)
 @NotNull
public Trigger getTrigger()

The underlying trigger resource.