software.amazon.awscdk.services.lambda.nodejs

Class NodejsFunctionProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.lambda.nodejs.NodejsFunctionProps.Jsii$Proxy

All Implemented Interfaces:

EventInvokeConfigOptions, FunctionOptions, BundlingOptions, NodejsFunctionProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

NodejsFunctionProps

@Stability(value=Experimental)
 @Internal
public static final class NodejsFunctionProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements NodejsFunctionProps

An implementation for NodejsFunctionProps

Nested Class Summary

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.nodejs.NodejsFunctionProps

NodejsFunctionProps.Builder, NodejsFunctionProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(Boolean awsSdkConnectionReuse, String depsLockFilePath, String entry, String handler, Runtime runtime, Boolean allowAllOutbound, Boolean allowPublicSubnet, VersionOptions currentVersionOptions, software.amazon.awscdk.services.sqs.IQueue deadLetterQueue, Boolean deadLetterQueueEnabled, String description, Map<String,String> environment, List<? extends IEventSource> events, FileSystem filesystem, String functionName, List<? extends software.amazon.awscdk.services.iam.PolicyStatement> initialPolicy, List<? extends ILayerVersion> layers, software.amazon.awscdk.services.logs.RetentionDays logRetention, LogRetentionRetryOptions logRetentionRetryOptions, software.amazon.awscdk.services.iam.IRole logRetentionRole, Number memorySize, Boolean profiling, software.amazon.awscdk.services.codeguruprofiler.IProfilingGroup profilingGroup, Number reservedConcurrentExecutions, software.amazon.awscdk.services.iam.IRole role, software.amazon.awscdk.services.ec2.ISecurityGroup securityGroup, List<? extends software.amazon.awscdk.services.ec2.ISecurityGroup> securityGroups, Duration timeout, Tracing tracing, software.amazon.awscdk.services.ec2.IVpc vpc, software.amazon.awscdk.services.ec2.SubnetSelection vpcSubnets, Duration maxEventAge, IDestination onFailure, IDestination onSuccess, Number retryAttempts, Map<String,String> buildArgs, BundlingDockerImage bundlingDockerImage, Map<String,String> bundlingEnvironment, String esbuildVersion, List<String> externalModules, Boolean forceDockerBundling, Map<String,String> loader, Boolean minify, List<String> nodeModules, Boolean sourceMap, String target) Constructor that initializes the object based on literal property values passed by the NodejsFunctionProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
Boolean	getAllowAllOutbound()
Boolean	getAllowPublicSubnet()
Boolean	getAwsSdkConnectionReuse() (experimental) Whether to automatically reuse TCP connections when working with the AWS SDK for JavaScript.
Map<String,String>	getBuildArgs() (experimental) Build arguments to pass when building the bundling image.
BundlingDockerImage	getBundlingDockerImage() (experimental) A custom bundling Docker image.
Map<String,String>	getBundlingEnvironment() (experimental) Environment variables defined when bundling runs.
VersionOptions	getCurrentVersionOptions()
software.amazon.awscdk.services.sqs.IQueue	getDeadLetterQueue()
Boolean	getDeadLetterQueueEnabled()
String	getDepsLockFilePath() (experimental) The path to the dependencies lock file (`yarn.lock` or `package-lock.json`).
String	getDescription()
String	getEntry() (experimental) Path to the entry file (JavaScript or TypeScript).
Map<String,String>	getEnvironment()
String	getEsbuildVersion() (experimental) The version of esbuild to use when running in a Docker container.
List<IEventSource>	getEvents()
List<String>	getExternalModules() (experimental) A list of modules that should be considered as externals (already available in the runtime).
FileSystem	getFilesystem()
Boolean	getForceDockerBundling() (experimental) Force bundling in a Docker container even if local bundling is possible.
String	getFunctionName()
String	getHandler() (experimental) The name of the exported handler in the entry file.
List<software.amazon.awscdk.services.iam.PolicyStatement>	getInitialPolicy()
List<ILayerVersion>	getLayers()
Map<String,String>	getLoader() (experimental) Use loaders to change how a given input file is interpreted.
software.amazon.awscdk.services.logs.RetentionDays	getLogRetention()
LogRetentionRetryOptions	getLogRetentionRetryOptions()
software.amazon.awscdk.services.iam.IRole	getLogRetentionRole()
Duration	getMaxEventAge()
Number	getMemorySize()
Boolean	getMinify() (experimental) Whether to minify files when bundling.
List<String>	getNodeModules() (experimental) A list of modules that should be installed instead of bundled.
IDestination	getOnFailure()
IDestination	getOnSuccess()
Boolean	getProfiling()
software.amazon.awscdk.services.codeguruprofiler.IProfilingGroup	getProfilingGroup()
Number	getReservedConcurrentExecutions()
Number	getRetryAttempts()
software.amazon.awscdk.services.iam.IRole	getRole()
Runtime	getRuntime() (experimental) The runtime environment.
software.amazon.awscdk.services.ec2.ISecurityGroup	getSecurityGroup()
List<software.amazon.awscdk.services.ec2.ISecurityGroup>	getSecurityGroups()
Boolean	getSourceMap() (experimental) Whether to include source maps when bundling.
String	getTarget() (experimental) Target environment for the generated JavaScript code.
Duration	getTimeout()
Tracing	getTracing()
software.amazon.awscdk.services.ec2.IVpc	getVpc()
software.amazon.awscdk.services.ec2.SubnetSelection	getVpcSubnets()
int	hashCode()

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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.services.lambda.nodejs.NodejsFunctionProps

builder

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(Boolean awsSdkConnectionReuse,
                     String depsLockFilePath,
                     String entry,
                     String handler,
                     Runtime runtime,
                     Boolean allowAllOutbound,
                     Boolean allowPublicSubnet,
                     VersionOptions currentVersionOptions,
                     software.amazon.awscdk.services.sqs.IQueue deadLetterQueue,
                     Boolean deadLetterQueueEnabled,
                     String description,
                     Map<String,String> environment,
                     List<? extends IEventSource> events,
                     FileSystem filesystem,
                     String functionName,
                     List<? extends software.amazon.awscdk.services.iam.PolicyStatement> initialPolicy,
                     List<? extends ILayerVersion> layers,
                     software.amazon.awscdk.services.logs.RetentionDays logRetention,
                     LogRetentionRetryOptions logRetentionRetryOptions,
                     software.amazon.awscdk.services.iam.IRole logRetentionRole,
                     Number memorySize,
                     Boolean profiling,
                     software.amazon.awscdk.services.codeguruprofiler.IProfilingGroup profilingGroup,
                     Number reservedConcurrentExecutions,
                     software.amazon.awscdk.services.iam.IRole role,
                     software.amazon.awscdk.services.ec2.ISecurityGroup securityGroup,
                     List<? extends software.amazon.awscdk.services.ec2.ISecurityGroup> securityGroups,
                     Duration timeout,
                     Tracing tracing,
                     software.amazon.awscdk.services.ec2.IVpc vpc,
                     software.amazon.awscdk.services.ec2.SubnetSelection vpcSubnets,
                     Duration maxEventAge,
                     IDestination onFailure,
                     IDestination onSuccess,
                     Number retryAttempts,
                     Map<String,String> buildArgs,
                     BundlingDockerImage bundlingDockerImage,
                     Map<String,String> bundlingEnvironment,
                     String esbuildVersion,
                     List<String> externalModules,
                     Boolean forceDockerBundling,
                     Map<String,String> loader,
                     Boolean minify,
                     List<String> nodeModules,
                     Boolean sourceMap,
                     String target)

Constructor that initializes the object based on literal property values passed by the NodejsFunctionProps.Builder.

Method Detail

getAwsSdkConnectionReuse

public final Boolean getAwsSdkConnectionReuse()

Description copied from interface: NodejsFunctionProps

(experimental) Whether to automatically reuse TCP connections when working with the AWS SDK for JavaScript.

This sets the AWS_NODEJS_CONNECTION_REUSE_ENABLED environment variable to 1.

Default: true

Specified by:

getAwsSdkConnectionReuse in interface NodejsFunctionProps

See Also:

https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/node-reusing-connections.html

getDepsLockFilePath

public final String getDepsLockFilePath()

Description copied from interface: NodejsFunctionProps

(experimental) The path to the dependencies lock file (`yarn.lock` or `package-lock.json`).

This will be used as the source for the volume mounted in the Docker container.

Modules specified in nodeModules will be installed using the right installer (npm or yarn) along with this lock file.

Default: - the path is found by walking up parent directories searching for a `yarn.lock` or `package-lock.json` file

Specified by:

getDepsLockFilePath in interface NodejsFunctionProps

getEntry

public final String getEntry()

Description copied from interface: NodejsFunctionProps

(experimental) Path to the entry file (JavaScript or TypeScript).

Default: - Derived from the name of the defining file and the construct's id. If the `NodejsFunction` is defined in `stack.ts` with `my-handler` as id (`new NodejsFunction(this, 'my-handler')`), the construct will look at `stack.my-handler.ts` and `stack.my-handler.js`.

Specified by:

getEntry in interface NodejsFunctionProps

getHandler

public final String getHandler()

Description copied from interface: NodejsFunctionProps

(experimental) The name of the exported handler in the entry file.

Default: handler

Specified by:

getHandler in interface NodejsFunctionProps

getRuntime

public final Runtime getRuntime()

Description copied from interface: NodejsFunctionProps

(experimental) The runtime environment.

Only runtimes of the Node.js family are supported.

Default: - `NODEJS_12_X` if `process.versions.node` >= '12.0.0', `NODEJS_10_X` otherwise.

Specified by:

getRuntime in interface NodejsFunctionProps

getAllowAllOutbound

public final Boolean getAllowAllOutbound()

Specified by:

getAllowAllOutbound in interface FunctionOptions

getAllowPublicSubnet

public final Boolean getAllowPublicSubnet()

Specified by:

getAllowPublicSubnet in interface FunctionOptions

getCurrentVersionOptions

public final VersionOptions getCurrentVersionOptions()

Specified by:

getCurrentVersionOptions in interface FunctionOptions

getDeadLetterQueue

public final software.amazon.awscdk.services.sqs.IQueue getDeadLetterQueue()

Specified by:

getDeadLetterQueue in interface FunctionOptions

getDeadLetterQueueEnabled

public final Boolean getDeadLetterQueueEnabled()

Specified by:

getDeadLetterQueueEnabled in interface FunctionOptions

getDescription

public final String getDescription()

Specified by:

getDescription in interface FunctionOptions

getEnvironment

public final Map<String,String> getEnvironment()

Specified by:

getEnvironment in interface FunctionOptions

getEvents

public final List<IEventSource> getEvents()

Specified by:

getEvents in interface FunctionOptions

getFilesystem

public final FileSystem getFilesystem()

Specified by:

getFilesystem in interface FunctionOptions

getFunctionName

public final String getFunctionName()

Specified by:

getFunctionName in interface FunctionOptions

getInitialPolicy

public final List<software.amazon.awscdk.services.iam.PolicyStatement> getInitialPolicy()

Specified by:

getInitialPolicy in interface FunctionOptions

getLayers

public final List<ILayerVersion> getLayers()

Specified by:

getLayers in interface FunctionOptions

getLogRetention

public final software.amazon.awscdk.services.logs.RetentionDays getLogRetention()

Specified by:

getLogRetention in interface FunctionOptions

getLogRetentionRetryOptions

public final LogRetentionRetryOptions getLogRetentionRetryOptions()

Specified by:

getLogRetentionRetryOptions in interface FunctionOptions

getLogRetentionRole

public final software.amazon.awscdk.services.iam.IRole getLogRetentionRole()

Specified by:

getLogRetentionRole in interface FunctionOptions

getMemorySize

public final Number getMemorySize()

Specified by:

getMemorySize in interface FunctionOptions

getProfiling

public final Boolean getProfiling()

Specified by:

getProfiling in interface FunctionOptions

getProfilingGroup

public final software.amazon.awscdk.services.codeguruprofiler.IProfilingGroup getProfilingGroup()

Specified by:

getProfilingGroup in interface FunctionOptions

getReservedConcurrentExecutions

public final Number getReservedConcurrentExecutions()

Specified by:

getReservedConcurrentExecutions in interface FunctionOptions

getRole

public final software.amazon.awscdk.services.iam.IRole getRole()

Specified by:

getRole in interface FunctionOptions

getSecurityGroup

public final software.amazon.awscdk.services.ec2.ISecurityGroup getSecurityGroup()

Specified by:

getSecurityGroup in interface FunctionOptions

getSecurityGroups

public final List<software.amazon.awscdk.services.ec2.ISecurityGroup> getSecurityGroups()

Specified by:

getSecurityGroups in interface FunctionOptions

getTimeout

public final Duration getTimeout()

Specified by:

getTimeout in interface FunctionOptions

getTracing

public final Tracing getTracing()

Specified by:

getTracing in interface FunctionOptions

getVpc

public final software.amazon.awscdk.services.ec2.IVpc getVpc()

Specified by:

getVpc in interface FunctionOptions

getVpcSubnets

public final software.amazon.awscdk.services.ec2.SubnetSelection getVpcSubnets()

Specified by:

getVpcSubnets in interface FunctionOptions

getMaxEventAge

public final Duration getMaxEventAge()

Specified by:

getMaxEventAge in interface EventInvokeConfigOptions

getOnFailure

public final IDestination getOnFailure()

Specified by:

getOnFailure in interface EventInvokeConfigOptions

getOnSuccess

public final IDestination getOnSuccess()

Specified by:

getOnSuccess in interface EventInvokeConfigOptions

getRetryAttempts

public final Number getRetryAttempts()

Specified by:

getRetryAttempts in interface EventInvokeConfigOptions

getBuildArgs

public final Map<String,String> getBuildArgs()

Description copied from interface: BundlingOptions

(experimental) Build arguments to pass when building the bundling image.

Default: - no build arguments are passed

Specified by:

getBuildArgs in interface BundlingOptions

getBundlingDockerImage

public final BundlingDockerImage getBundlingDockerImage()

Description copied from interface: BundlingOptions

(experimental) A custom bundling Docker image.

This image should have esbuild installed globally. If you plan to use nodeModules it should also have npm or yarn depending on the lock file you're using.

See https://github.com/aws/aws-cdk/blob/master/packages/%40aws-cdk/aws-lambda-nodejs/lib/Dockerfile for the default image provided by @aws-cdk/aws-lambda-nodejs.

Default: - use the Docker image provided by

Specified by:

getBundlingDockerImage in interface BundlingOptions

getBundlingEnvironment

public final Map<String,String> getBundlingEnvironment()

Description copied from interface: BundlingOptions

(experimental) Environment variables defined when bundling runs.

Default: - no environment variables are defined.

Specified by:

getBundlingEnvironment in interface BundlingOptions

getEsbuildVersion

public final String getEsbuildVersion()

Description copied from interface: BundlingOptions

(experimental) The version of esbuild to use when running in a Docker container.

Default: - latest v0

Specified by:

getEsbuildVersion in interface BundlingOptions

getExternalModules

public final List<String> getExternalModules()

Description copied from interface: BundlingOptions

(experimental) A list of modules that should be considered as externals (already available in the runtime).

Default: ['aws-sdk']

Specified by:

getExternalModules in interface BundlingOptions

getForceDockerBundling

public final Boolean getForceDockerBundling()

Description copied from interface: BundlingOptions

(experimental) Force bundling in a Docker container even if local bundling is possible.

This is useful if your function relies on node modules that should be installed (nodeModules) in a Lambda compatible environment.

Default: false

Specified by:

getForceDockerBundling in interface BundlingOptions

getLoader

public final Map<String,String> getLoader()

Description copied from interface: BundlingOptions

(experimental) Use loaders to change how a given input file is interpreted.

Configuring a loader for a given file type lets you load that file type with an import statement or a require call.

Default: - use esbuild default loaders

Example:

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 {".png";"dataurl";
 }

Specified by:

getLoader in interface BundlingOptions

See Also:

https://esbuild.github.io/api/#loader

getMinify

public final Boolean getMinify()

Description copied from interface: BundlingOptions

(experimental) Whether to minify files when bundling.

Default: false

Specified by:

getMinify in interface BundlingOptions

getNodeModules

public final List<String> getNodeModules()

Description copied from interface: BundlingOptions

(experimental) A list of modules that should be installed instead of bundled.

Modules are installed in a Lambda compatible environnment only when bundling runs in Docker.

Default: - all modules are bundled

Specified by:

getNodeModules in interface BundlingOptions

getSourceMap

public final Boolean getSourceMap()

Description copied from interface: BundlingOptions

(experimental) Whether to include source maps when bundling.

Default: false

Specified by:

getSourceMap in interface BundlingOptions

getTarget

public final String getTarget()

Description copied from interface: BundlingOptions

(experimental) Target environment for the generated JavaScript code.

Default: - the node version of the runtime

Specified by:

getTarget in interface BundlingOptions

See Also:

https://esbuild.github.io/api/#target

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object