software.amazon.awscdk.services.lambda

Class QualifiedFunctionBase

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.QualifiedFunctionBase

All Implemented Interfaces:

IDependable, IResource, IClientVpnConnectionHandler, IConnectable, IGrantable, IFunction, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

Direct Known Subclasses:

Alias, Version

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-05-10T17:05:56.588Z")
 @Stability(value=Stable)
public abstract class QualifiedFunctionBase
extends FunctionBase

Nested Class Summary

Nested classes/interfaces inherited from class software.constructs.Construct

software.constructs.Construct.Builder

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IClientVpnConnectionHandler.Jsii$Default

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	configureAsyncInvoke(EventInvokeConfigOptions options) Configures options for asynchronous invocation.
void	considerWarningOnInvokeFunctionPermissions(Construct _scope, String _action) A warning will be added to functions under the following conditions: - permissions that include `lambda:InvokeFunction` are added to the unqualified function.
abstract IFunction	getLambda()
IVersion	getLatestVersion() The `$LATEST` version of this function.
ConstructNode	getPermissionsNode() The construct node where permissions are attached.
protected abstract String	getQualifier() The qualifier of the version or alias of this function.
List<String>	getResourceArnsForGrantInvoke() The ARN(s) to put into the resource field of the generated IAM policy for grantInvoke().

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

addEventSource, addEventSourceMapping, addFunctionUrl, addFunctionUrl, addPermission, addToRolePolicy, getArchitecture, getCanCreatePermissions, getConnections, getFunctionArn, getFunctionName, getGrantPrincipal, getIsBoundToVpc, getRole, 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.IResource

applyRemovalPolicy, getEnv, getStack

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

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

QualifiedFunctionBase

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

QualifiedFunctionBase

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

QualifiedFunctionBase

@Stability(value=Stable)
protected QualifiedFunctionBase(@NotNull
                                                         software.constructs.Construct scope,
                                                         @NotNull
                                                         String id,
                                                         @Nullable
                                                         ResourceProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

QualifiedFunctionBase

@Stability(value=Stable)
protected QualifiedFunctionBase(@NotNull
                                                         software.constructs.Construct scope,
                                                         @NotNull
                                                         String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

configureAsyncInvoke

@Stability(value=Stable)
public void configureAsyncInvoke(@NotNull
                                                          EventInvokeConfigOptions options)

Configures options for asynchronous invocation.

Specified by:

configureAsyncInvoke in interface IFunction

Overrides:

configureAsyncInvoke in class FunctionBase

Parameters:

options - This parameter is required.

considerWarningOnInvokeFunctionPermissions

@Stability(value=Stable)
public void considerWarningOnInvokeFunctionPermissions(@NotNull
                                                                                Construct _scope,
                                                                                @NotNull
                                                                                String _action)

A warning will be added to functions under the following conditions: - permissions that include `lambda:InvokeFunction` are added to the unqualified function.

• function.currentVersion is invoked before or after the permission is created.

This applies only to permissions on Lambda functions, not versions or aliases. This function is overridden as a noOp for QualifiedFunctionBase.

Overrides:

considerWarningOnInvokeFunctionPermissions in class FunctionBase

Parameters:

_scope - This parameter is required.

_action - This parameter is required.

getLambda

@Stability(value=Stable)
 @NotNull
public abstract IFunction getLambda()

getLatestVersion

@Stability(value=Stable)
 @NotNull
public IVersion getLatestVersion()

The `$LATEST` version of this function.

Note that this is reference to a non-specific AWS Lambda version, which means the function this version refers to can return different results in different invocations.

To obtain a reference to an explicit version which references the current function configuration, use lambdaFunction.currentVersion instead.

Specified by:

getLatestVersion in interface IFunction

Overrides:

getLatestVersion in class FunctionBase

getPermissionsNode

@Stability(value=Stable)
 @NotNull
public ConstructNode getPermissionsNode()

The construct node where permissions are attached.

Specified by:

getPermissionsNode in interface IFunction

Specified by:

getPermissionsNode in class FunctionBase

getQualifier

@Stability(value=Stable)
 @NotNull
protected abstract String getQualifier()

The qualifier of the version or alias of this function.

A qualifier is the identifier that's appended to a version or alias ARN.

See Also:

https://docs.aws.amazon.com/lambda/latest/dg/API_GetFunctionConfiguration.html#API_GetFunctionConfiguration_RequestParameters

getResourceArnsForGrantInvoke

@Stability(value=Stable)
 @NotNull
public List<String> getResourceArnsForGrantInvoke()

The ARN(s) to put into the resource field of the generated IAM policy for grantInvoke().

Specified by:

getResourceArnsForGrantInvoke in interface IFunction

Specified by:

getResourceArnsForGrantInvoke in class FunctionBase