Documentation
¶
Index ¶
- func NewNodejsFunction_Override(n NodejsFunction, scope constructs.Construct, id *string, ...)
- func NodejsFunction_ClassifyVersionProperty(propertyName *string, locked *bool)
- func NodejsFunction_FromFunctionArn(scope constructs.Construct, id *string, functionArn *string) awslambda.IFunction
- func NodejsFunction_FromFunctionAttributes(scope constructs.Construct, id *string, attrs *awslambda.FunctionAttributes) awslambda.IFunction
- func NodejsFunction_FromFunctionName(scope constructs.Construct, id *string, functionName *string) awslambda.IFunction
- func NodejsFunction_IsConstruct(x interface{}) *bool
- func NodejsFunction_IsOwnedResource(construct constructs.IConstruct) *bool
- func NodejsFunction_IsResource(construct constructs.IConstruct) *bool
- func NodejsFunction_MetricAll(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric
- func NodejsFunction_MetricAllConcurrentExecutions(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
- func NodejsFunction_MetricAllDuration(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
- func NodejsFunction_MetricAllErrors(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
- func NodejsFunction_MetricAllInvocations(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
- func NodejsFunction_MetricAllThrottles(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
- func NodejsFunction_MetricAllUnreservedConcurrentExecutions(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
- type BundlingOptions
- type Charset
- type ICommandHooks
- type LogLevel
- type NodejsFunction
- type NodejsFunctionProps
- type OutputFormat
- type SourceMapMode
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewNodejsFunction_Override ¶
func NewNodejsFunction_Override(n NodejsFunction, scope constructs.Construct, id *string, props *NodejsFunctionProps)
func NodejsFunction_ClassifyVersionProperty ¶
Record whether specific properties in the `AWS::Lambda::Function` resource should also be associated to the Version resource.
See 'currentVersion' section in the module README for more details.
func NodejsFunction_FromFunctionArn ¶
func NodejsFunction_FromFunctionArn(scope constructs.Construct, id *string, functionArn *string) awslambda.IFunction
Import a lambda function into the CDK using its ARN.
func NodejsFunction_FromFunctionAttributes ¶
func NodejsFunction_FromFunctionAttributes(scope constructs.Construct, id *string, attrs *awslambda.FunctionAttributes) awslambda.IFunction
Creates a Lambda function object which represents a function not defined within this stack.
func NodejsFunction_FromFunctionName ¶ added in v2.14.0
func NodejsFunction_FromFunctionName(scope constructs.Construct, id *string, functionName *string) awslambda.IFunction
Import a lambda function into the CDK using its name.
func NodejsFunction_IsConstruct ¶
func NodejsFunction_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func NodejsFunction_IsOwnedResource ¶ added in v2.32.0
func NodejsFunction_IsOwnedResource(construct constructs.IConstruct) *bool
Returns true if the construct was created by CDK, and false otherwise.
func NodejsFunction_IsResource ¶
func NodejsFunction_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func NodejsFunction_MetricAll ¶
func NodejsFunction_MetricAll(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric
Return the given named metric for this Lambda.
func NodejsFunction_MetricAllConcurrentExecutions ¶
func NodejsFunction_MetricAllConcurrentExecutions(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
Metric for the number of concurrent executions across all Lambdas.
func NodejsFunction_MetricAllDuration ¶
func NodejsFunction_MetricAllDuration(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
Metric for the Duration executing all Lambdas.
func NodejsFunction_MetricAllErrors ¶
func NodejsFunction_MetricAllErrors(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
Metric for the number of Errors executing all Lambdas.
func NodejsFunction_MetricAllInvocations ¶
func NodejsFunction_MetricAllInvocations(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
Metric for the number of invocations of all Lambdas.
func NodejsFunction_MetricAllThrottles ¶
func NodejsFunction_MetricAllThrottles(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
Metric for the number of throttled invocations of all Lambdas.
func NodejsFunction_MetricAllUnreservedConcurrentExecutions ¶
func NodejsFunction_MetricAllUnreservedConcurrentExecutions(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
Metric for the number of unreserved concurrent executions across all Lambdas.
Types ¶
type BundlingOptions ¶
type BundlingOptions struct {
// The command to run in the container.
Command *[]*string `field:"optional" json:"command" yaml:"command"`
// The entrypoint to run in the container.
Entrypoint *[]*string `field:"optional" json:"entrypoint" yaml:"entrypoint"`
// The environment variables to pass to the container.
Environment *map[string]*string `field:"optional" json:"environment" yaml:"environment"`
// Docker [Networking options](https://docs.docker.com/engine/reference/commandline/run/#connect-a-container-to-a-network---network).
Network *string `field:"optional" json:"network" yaml:"network"`
// [Security configuration](https://docs.docker.com/engine/reference/run/#security-configuration) when running the docker container.
SecurityOpt *string `field:"optional" json:"securityOpt" yaml:"securityOpt"`
// The user to use when running the container.
User *string `field:"optional" json:"user" yaml:"user"`
// Docker volumes to mount.
Volumes *[]*awscdk.DockerVolume `field:"optional" json:"volumes" yaml:"volumes"`
// Where to mount the specified volumes from.
// See: https://docs.docker.com/engine/reference/commandline/run/#mount-volumes-from-container---volumes-from
//
VolumesFrom *[]*string `field:"optional" json:"volumesFrom" yaml:"volumesFrom"`
// Working directory inside the container.
WorkingDirectory *string `field:"optional" json:"workingDirectory" yaml:"workingDirectory"`
// Specify a custom hash for this asset.
//
// For consistency, this custom hash will
// be SHA256 hashed and encoded as hex. The resulting hash will be the asset
// hash.
//
// NOTE: the hash is used in order to identify a specific revision of the asset, and
// used for optimizing and caching deployment activities related to this asset such as
// packaging, uploading to Amazon S3, etc. If you chose to customize the hash, you will
// need to make sure it is updated every time the asset changes, or otherwise it is
// possible that some deployments will not be invalidated.
AssetHash *string `field:"optional" json:"assetHash" yaml:"assetHash"`
// Use this to insert an arbitrary string at the beginning of generated JavaScript files.
//
// This is similar to footer which inserts at the end instead of the beginning.
//
// This is commonly used to insert comments:.
Banner *string `field:"optional" json:"banner" yaml:"banner"`
// Build arguments to pass when building the bundling image.
BuildArgs *map[string]*string `field:"optional" json:"buildArgs" yaml:"buildArgs"`
// Which option to use to copy the source files to the docker container and output files back.
BundlingFileAccess awscdk.BundlingFileAccess `field:"optional" json:"bundlingFileAccess" yaml:"bundlingFileAccess"`
// The charset to use for esbuild's output.
//
// By default esbuild's output is ASCII-only. Any non-ASCII characters are escaped
// using backslash escape sequences. Using escape sequences makes the generated output
// slightly bigger, and also makes it harder to read. If you would like for esbuild to print
// the original characters without using escape sequences, use `Charset.UTF8`.
// See: https://esbuild.github.io/api/#charset
//
Charset Charset `field:"optional" json:"charset" yaml:"charset"`
// Command hooks.
CommandHooks ICommandHooks `field:"optional" json:"commandHooks" yaml:"commandHooks"`
// Replace global identifiers with constant expressions.
//
// For example, `{ 'process.env.DEBUG': 'true' }`.
//
// Another example, `{ 'process.env.API_KEY': JSON.stringify('xxx-xxxx-xxx') }`.
Define *map[string]*string `field:"optional" json:"define" yaml:"define"`
// A custom bundling Docker image.
//
// This image should have esbuild installed globally. If you plan to use `nodeModules`
// it should also have `npm`, `yarn` or `pnpm` depending on the lock file you're using.
//
// See https://github.com/aws/aws-cdk/blob/main/packages/%40aws-cdk/aws-lambda-nodejs/lib/Dockerfile
// for the default image provided by @aws-cdk/aws-lambda-nodejs.
DockerImage awscdk.DockerImage `field:"optional" json:"dockerImage" yaml:"dockerImage"`
// Build arguments to pass into esbuild.
//
// For example, to add the [--log-limit](https://esbuild.github.io/api/#log-limit) flag:
//
// “`text
// new NodejsFunction(scope, id, {
// ...
// bundling: {
// esbuildArgs: {
// "--log-limit": "0",
// }
// }
// });
// “`.
EsbuildArgs *map[string]interface{} `field:"optional" json:"esbuildArgs" yaml:"esbuildArgs"`
// The version of esbuild to use when running in a Docker container.
EsbuildVersion *string `field:"optional" json:"esbuildVersion" yaml:"esbuildVersion"`
// A list of modules that should be considered as externals (already available in the runtime).
ExternalModules *[]*string `field:"optional" json:"externalModules" yaml:"externalModules"`
//
// This is similar to banner which inserts at the beginning instead of the end.
//
// This is commonly used to insert comments.
Footer *string `field:"optional" json:"footer" yaml:"footer"`
// 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.
ForceDockerBundling *bool `field:"optional" json:"forceDockerBundling" yaml:"forceDockerBundling"`
// Output format for the generated JavaScript files.
Format OutputFormat `field:"optional" json:"format" yaml:"format"`
// This option allows you to automatically replace a global variable with an import from another file.
// See: https://esbuild.github.io/api/#inject
//
Inject *[]*string `field:"optional" json:"inject" yaml:"inject"`
// Whether to preserve the original `name` values even in minified code.
//
// In JavaScript the `name` property on functions and classes defaults to a
// nearby identifier in the source code.
//
// However, minification renames symbols to reduce code size and bundling
// sometimes need to rename symbols to avoid collisions. That changes value of
// the `name` property for many of these cases. This is usually fine because
// the `name` property is normally only used for debugging. However, some
// frameworks rely on the `name` property for registration and binding purposes.
// If this is the case, you can enable this option to preserve the original
// `name` values even in minified code.
KeepNames *bool `field:"optional" json:"keepNames" yaml:"keepNames"`
// 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.
//
// For example, `{ '.png': 'dataurl' }`.
// See: https://esbuild.github.io/api/#loader
//
Loader *map[string]*string `field:"optional" json:"loader" yaml:"loader"`
// Log level for esbuild.
//
// This is also propagated to the package manager and
// applies to its specific install command.
LogLevel LogLevel `field:"optional" json:"logLevel" yaml:"logLevel"`
// How to determine the entry point for modules.
//
// Try ['module', 'main'] to default to ES module versions.
MainFields *[]*string `field:"optional" json:"mainFields" yaml:"mainFields"`
// This option tells esbuild to write out a JSON file relative to output directory with metadata about the build.
//
// The metadata in this JSON file follows this schema (specified using TypeScript syntax):
//
// “`text
// {
// outputs: {
// [path: string]: {
// bytes: number
// inputs: {
// [path: string]: { bytesInOutput: number }
// }
// imports: { path: string }[]
// exports: string[]
// }
// }
// }
// “`
// This data can then be analyzed by other tools. For example,
// bundle buddy can consume esbuild's metadata format and generates a treemap visualization
// of the modules in your bundle and how much space each one takes up.
// See: https://esbuild.github.io/api/#metafile
//
Metafile *bool `field:"optional" json:"metafile" yaml:"metafile"`
// Whether to minify files when bundling.
Minify *bool `field:"optional" json:"minify" yaml:"minify"`
// A list of modules that should be installed instead of bundled.
//
// Modules are
// installed in a Lambda compatible environment only when bundling runs in
// Docker.
NodeModules *[]*string `field:"optional" json:"nodeModules" yaml:"nodeModules"`
// Run compilation using tsc before running file through bundling step.
//
// This usually is not required unless you are using new experimental features that
// are only supported by typescript's `tsc` compiler.
// One example of such feature is `emitDecoratorMetadata`.
PreCompilation *bool `field:"optional" json:"preCompilation" yaml:"preCompilation"`
// Whether to include source maps when bundling.
SourceMap *bool `field:"optional" json:"sourceMap" yaml:"sourceMap"`
// Source map mode to be used when bundling.
// See: https://esbuild.github.io/api/#sourcemap
//
SourceMapMode SourceMapMode `field:"optional" json:"sourceMapMode" yaml:"sourceMapMode"`
// Whether to include original source code in source maps when bundling.
// See: https://esbuild.github.io/api/#sources-content
//
SourcesContent *bool `field:"optional" json:"sourcesContent" yaml:"sourcesContent"`
// Target environment for the generated JavaScript code.
// See: https://esbuild.github.io/api/#target
//
Target *string `field:"optional" json:"target" yaml:"target"`
// Normally the esbuild automatically discovers `tsconfig.json` files and reads their contents during a build.
//
// However, you can also configure a custom `tsconfig.json` file to use instead.
//
// This is similar to entry path, you need to provide path to your custom `tsconfig.json`.
//
// This can be useful if you need to do multiple builds of the same code with different settings.
//
// For example, `{ 'tsconfig': 'path/custom.tsconfig.json' }`.
Tsconfig *string `field:"optional" json:"tsconfig" yaml:"tsconfig"`
}
Bundling options.
Example:
nodejs.NewNodejsFunction(this, jsii.String("my-handler"), &NodejsFunctionProps{
Bundling: &BundlingOptions{
DockerImage: awscdk.DockerImage_FromBuild(jsii.String("/path/to/Dockerfile")),
},
})
type Charset ¶
type Charset string
Charset for esbuild's output.
Example:
nodejs.NewNodejsFunction(this, jsii.String("my-handler"), &NodejsFunctionProps{
Bundling: &BundlingOptions{
Minify: jsii.Boolean(true),
// minify code, defaults to false
SourceMap: jsii.Boolean(true),
// include source map, defaults to false
SourceMapMode: nodejs.SourceMapMode_INLINE,
// defaults to SourceMapMode.DEFAULT
SourcesContent: jsii.Boolean(false),
// do not include original source into source map, defaults to true
Target: jsii.String("es2020"),
// target environment for the generated JavaScript code
Loader: map[string]*string{
// Use the 'dataurl' loader for '.png' files
".png": jsii.String("dataurl"),
},
Define: map[string]*string{
// Replace strings during build time
"process.env.API_KEY": JSON.stringify(jsii.String("xxx-xxxx-xxx")),
"process.env.PRODUCTION": JSON.stringify(jsii.Boolean(true)),
"process.env.NUMBER": JSON.stringify(jsii.Number(123)),
},
LogLevel: nodejs.LogLevel_SILENT,
// defaults to LogLevel.WARNING
KeepNames: jsii.Boolean(true),
// defaults to false
Tsconfig: jsii.String("custom-tsconfig.json"),
// use custom-tsconfig.json instead of default,
Metafile: jsii.Boolean(true),
// include meta file, defaults to false
Banner: jsii.String("/* comments */"),
// requires esbuild >= 0.9.0, defaults to none
Footer: jsii.String("/* comments */"),
// requires esbuild >= 0.9.0, defaults to none
Charset: nodejs.Charset_UTF8,
// do not escape non-ASCII characters, defaults to Charset.ASCII
Format: nodejs.OutputFormat_ESM,
// ECMAScript module output format, defaults to OutputFormat.CJS (OutputFormat.ESM requires Node.js 14.x)
MainFields: []*string{
jsii.String("module"),
jsii.String("main"),
},
// prefer ECMAScript versions of dependencies
Inject: []*string{
jsii.String("./my-shim.js"),
jsii.String("./other-shim.js"),
},
// allows to automatically replace a global variable with an import from another file
EsbuildArgs: map[string]interface{}{
// Pass additional arguments to esbuild
"--log-limit": jsii.String("0"),
"--splitting": jsii.Boolean(true),
},
},
})
type ICommandHooks ¶
type ICommandHooks interface {
// Returns commands to run after bundling.
//
// Commands are chained with `&&`.
AfterBundling(inputDir *string, outputDir *string) *[]*string
// Returns commands to run before bundling.
//
// Commands are chained with `&&`.
BeforeBundling(inputDir *string, outputDir *string) *[]*string
// Returns commands to run before installing node modules.
//
// This hook only runs when node modules are installed.
//
// Commands are chained with `&&`.
BeforeInstall(inputDir *string, outputDir *string) *[]*string
}
Command hooks.
These commands will run in the environment in which bundling occurs: inside the container for Docker bundling or on the host OS for local bundling.
Commands are chained with `&&`.
The following example (specified in TypeScript) copies a file from the input directory to the output directory to include it in the bundled asset:
```text
afterBundling(inputDir: string, outputDir: string): string[]{
return [`cp ${inputDir}/my-binary.node ${outputDir}`];
}
```.
type LogLevel ¶
type LogLevel string
Log levels for esbuild and package managers' install commands.
Example:
nodejs.NewNodejsFunction(this, jsii.String("my-handler"), &NodejsFunctionProps{
Bundling: &BundlingOptions{
Minify: jsii.Boolean(true),
// minify code, defaults to false
SourceMap: jsii.Boolean(true),
// include source map, defaults to false
SourceMapMode: nodejs.SourceMapMode_INLINE,
// defaults to SourceMapMode.DEFAULT
SourcesContent: jsii.Boolean(false),
// do not include original source into source map, defaults to true
Target: jsii.String("es2020"),
// target environment for the generated JavaScript code
Loader: map[string]*string{
// Use the 'dataurl' loader for '.png' files
".png": jsii.String("dataurl"),
},
Define: map[string]*string{
// Replace strings during build time
"process.env.API_KEY": JSON.stringify(jsii.String("xxx-xxxx-xxx")),
"process.env.PRODUCTION": JSON.stringify(jsii.Boolean(true)),
"process.env.NUMBER": JSON.stringify(jsii.Number(123)),
},
LogLevel: nodejs.LogLevel_SILENT,
// defaults to LogLevel.WARNING
KeepNames: jsii.Boolean(true),
// defaults to false
Tsconfig: jsii.String("custom-tsconfig.json"),
// use custom-tsconfig.json instead of default,
Metafile: jsii.Boolean(true),
// include meta file, defaults to false
Banner: jsii.String("/* comments */"),
// requires esbuild >= 0.9.0, defaults to none
Footer: jsii.String("/* comments */"),
// requires esbuild >= 0.9.0, defaults to none
Charset: nodejs.Charset_UTF8,
// do not escape non-ASCII characters, defaults to Charset.ASCII
Format: nodejs.OutputFormat_ESM,
// ECMAScript module output format, defaults to OutputFormat.CJS (OutputFormat.ESM requires Node.js 14.x)
MainFields: []*string{
jsii.String("module"),
jsii.String("main"),
},
// prefer ECMAScript versions of dependencies
Inject: []*string{
jsii.String("./my-shim.js"),
jsii.String("./other-shim.js"),
},
// allows to automatically replace a global variable with an import from another file
EsbuildArgs: map[string]interface{}{
// Pass additional arguments to esbuild
"--log-limit": jsii.String("0"),
"--splitting": jsii.Boolean(true),
},
},
})
type NodejsFunction ¶
type NodejsFunction interface {
awslambda.Function
// The architecture of this Lambda Function (this is an optional attribute and defaults to X86_64).
Architecture() awslambda.Architecture
// Whether the addPermission() call adds any permissions.
//
// True for new Lambdas, false for version $LATEST and imported Lambdas
// from different accounts.
CanCreatePermissions() *bool
// Access the Connections object.
//
// Will fail if not a VPC-enabled Lambda Function.
Connections() awsec2.Connections
// Returns a `lambda.Version` which represents the current version of this Lambda function. A new version will be created every time the function's configuration changes.
//
// You can specify options for this version using the `currentVersionOptions`
// prop when initializing the `lambda.Function`.
CurrentVersion() awslambda.Version
// The DLQ (as queue) associated with this Lambda Function (this is an optional attribute).
DeadLetterQueue() awssqs.IQueue
// The DLQ (as topic) associated with this Lambda Function (this is an optional attribute).
DeadLetterTopic() awssns.ITopic
// The environment this resource belongs to.
//
// For resources that are created and managed by the CDK
// (generally, those created by creating new class instances like Role, Bucket, etc.),
// this is always the same as the environment of the stack they belong to;
// however, for imported resources
// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
// that might be different than the stack they were imported into.
Env() *awscdk.ResourceEnvironment
// ARN of this function.
FunctionArn() *string
// Name of this function.
FunctionName() *string
// The principal this Lambda Function is running as.
GrantPrincipal() awsiam.IPrincipal
// Whether or not this Lambda function was bound to a VPC.
//
// If this is is `false`, trying to access the `connections` object will fail.
IsBoundToVpc() *bool
// 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.
LatestVersion() awslambda.IVersion
// The LogGroup where the Lambda function's logs are made available.
//
// If either `logRetention` is set or this property is called, a CloudFormation custom resource is added to the stack that
// pre-creates the log group as part of the stack deployment, if it already doesn't exist, and sets the correct log retention
// period (never expire, by default).
//
// Further, if the log group already exists and the `logRetention` is not set, the custom resource will reset the log retention
// to never expire even if it was configured with a different value.
LogGroup() awslogs.ILogGroup
// The tree node.
Node() constructs.Node
// The construct node where permissions are attached.
PermissionsNode() constructs.Node
// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
//
// This value will resolve to one of the following:
// - a concrete value (e.g. `"my-awesome-bucket"`)
// - `undefined`, when a name should be generated by CloudFormation
// - a concrete name generated automatically during synthesis, in
// cross-environment scenarios.
PhysicalName() *string
// The ARN(s) to put into the resource field of the generated IAM policy for grantInvoke().
ResourceArnsForGrantInvoke() *[]*string
// Execution role associated with this function.
Role() awsiam.IRole
// The runtime configured for this lambda.
Runtime() awslambda.Runtime
// The stack in which this resource is defined.
Stack() awscdk.Stack
// The timeout configured for this lambda.
Timeout() awscdk.Duration
// Defines an alias for this function.
//
// The alias will automatically be updated to point to the latest version of
// the function as it is being updated during a deployment.
//
// “`ts
// declare const fn: lambda.Function;
//
// fn.addAlias('Live');
//
// // Is equivalent to
//
// new lambda.Alias(this, 'AliasLive', {
// aliasName: 'Live',
// version: fn.currentVersion,
// });
// “`.
AddAlias(aliasName *string, options *awslambda.AliasOptions) awslambda.Alias
// Adds an environment variable to this Lambda function.
//
// If this is a ref to a Lambda function, this operation results in a no-op.
AddEnvironment(key *string, value *string, options *awslambda.EnvironmentOptions) awslambda.Function
// Adds an event source to this function.
//
// Event sources are implemented in the @aws-cdk/aws-lambda-event-sources module.
//
// The following example adds an SQS Queue as an event source:
// “`
// import { SqsEventSource } from '@aws-cdk/aws-lambda-event-sources';
// myFunction.addEventSource(new SqsEventSource(myQueue));
// “`.
AddEventSource(source awslambda.IEventSource)
// Adds an event source that maps to this AWS Lambda function.
AddEventSourceMapping(id *string, options *awslambda.EventSourceMappingOptions) awslambda.EventSourceMapping
// Adds a url to this lambda function.
AddFunctionUrl(options *awslambda.FunctionUrlOptions) awslambda.FunctionUrl
// Adds one or more Lambda Layers to this Lambda function.
AddLayers(layers ...awslambda.ILayerVersion)
// Adds a permission to the Lambda resource policy.
// See: Permission for details.
//
AddPermission(id *string, permission *awslambda.Permission)
// Adds a statement to the IAM role assumed by the instance.
AddToRolePolicy(statement awsiam.PolicyStatement)
// Apply the given removal policy to this resource.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
// Configures options for asynchronous invocation.
ConfigureAsyncInvoke(options *awslambda.EventInvokeConfigOptions)
// 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.
ConsiderWarningOnInvokeFunctionPermissions(scope constructs.Construct, action *string)
GeneratePhysicalName() *string
// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
//
// Normally, this token will resolve to `arnAttr`, but if the resource is
// referenced across environments, `arnComponents` will be used to synthesize
// a concrete ARN with the resource's physical name. Make sure to reference
// `this.physicalName` in `arnComponents`.
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
//
// Normally, this token will resolve to `nameAttr`, but if the resource is
// referenced across environments, it will be resolved to `this.physicalName`,
// which will be a concrete name.
GetResourceNameAttribute(nameAttr *string) *string
// Grant the given identity permissions to invoke this Lambda.
GrantInvoke(grantee awsiam.IGrantable) awsiam.Grant
// Grant the given identity permissions to invoke this Lambda Function URL.
GrantInvokeUrl(grantee awsiam.IGrantable) awsiam.Grant
// Mix additional information into the hash of the Version object.
//
// The Lambda Function construct does its best to automatically create a new
// Version when anything about the Function changes (its code, its layers,
// any of the other properties).
//
// However, you can sometimes source information from places that the CDK cannot
// look into, like the deploy-time values of SSM parameters. In those cases,
// the CDK would not force the creation of a new Version object when it actually
// should.
//
// This method can be used to invalidate the current Version object. Pass in
// any string into this method, and make sure the string changes when you know
// a new Version needs to be created.
//
// This method may be called more than once.
InvalidateVersionBasedOn(x *string)
// Return the given named metric for this Function.
Metric(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric
// How long execution of this Lambda takes.
//
// Average over 5 minutes.
MetricDuration(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
// How many invocations of this Lambda fail.
//
// Sum over 5 minutes.
MetricErrors(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
// How often this Lambda is invoked.
//
// Sum over 5 minutes.
MetricInvocations(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
// How often this Lambda is throttled.
//
// Sum over 5 minutes.
MetricThrottles(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
// Returns a string representation of this construct.
ToString() *string
WarnInvokeFunctionPermissions(scope constructs.Construct)
}
A Node.js Lambda function bundled using esbuild.
Example:
nodejs.NewNodejsFunction(this, jsii.String("my-handler"), &NodejsFunctionProps{
Bundling: &BundlingOptions{
Network: jsii.String("host"),
SecurityOpt: jsii.String("no-new-privileges"),
User: jsii.String("user:group"),
VolumesFrom: []*string{
jsii.String("777f7dc92da7"),
},
Volumes: []dockerVolume{
&dockerVolume{
HostPath: jsii.String("/host-path"),
ContainerPath: jsii.String("/container-path"),
},
},
},
})
func NewNodejsFunction ¶
func NewNodejsFunction(scope constructs.Construct, id *string, props *NodejsFunctionProps) NodejsFunction
type NodejsFunctionProps ¶
type NodejsFunctionProps struct {
// The maximum age of a request that Lambda sends to a function for processing.
//
// Minimum: 60 seconds
// Maximum: 6 hours.
MaxEventAge awscdk.Duration `field:"optional" json:"maxEventAge" yaml:"maxEventAge"`
// The destination for failed invocations.
OnFailure awslambda.IDestination `field:"optional" json:"onFailure" yaml:"onFailure"`
// The destination for successful invocations.
OnSuccess awslambda.IDestination `field:"optional" json:"onSuccess" yaml:"onSuccess"`
// The maximum number of times to retry when the function returns an error.
//
// Minimum: 0
// Maximum: 2.
RetryAttempts *float64 `field:"optional" json:"retryAttempts" yaml:"retryAttempts"`
// Specify the configuration of AWS Distro for OpenTelemetry (ADOT) instrumentation.
// See: https://aws-otel.github.io/docs/getting-started/lambda
//
AdotInstrumentation *awslambda.AdotInstrumentationConfig `field:"optional" json:"adotInstrumentation" yaml:"adotInstrumentation"`
// Whether to allow the Lambda to send all network traffic.
//
// If set to false, you must individually add traffic rules to allow the
// Lambda to connect to network targets.
AllowAllOutbound *bool `field:"optional" json:"allowAllOutbound" yaml:"allowAllOutbound"`
// Lambda Functions in a public subnet can NOT access the internet.
//
// Use this property to acknowledge this limitation and still place the function in a public subnet.
// See: https://stackoverflow.com/questions/52992085/why-cant-an-aws-lambda-function-inside-a-public-subnet-in-a-vpc-connect-to-the/52994841#52994841
//
AllowPublicSubnet *bool `field:"optional" json:"allowPublicSubnet" yaml:"allowPublicSubnet"`
// The system architectures compatible with this lambda function.
Architecture awslambda.Architecture `field:"optional" json:"architecture" yaml:"architecture"`
// Code signing config associated with this function.
CodeSigningConfig awslambda.ICodeSigningConfig `field:"optional" json:"codeSigningConfig" yaml:"codeSigningConfig"`
// Options for the `lambda.Version` resource automatically created by the `fn.currentVersion` method.
CurrentVersionOptions *awslambda.VersionOptions `field:"optional" json:"currentVersionOptions" yaml:"currentVersionOptions"`
// The SQS queue to use if DLQ is enabled.
//
// If SNS topic is desired, specify `deadLetterTopic` property instead.
DeadLetterQueue awssqs.IQueue `field:"optional" json:"deadLetterQueue" yaml:"deadLetterQueue"`
// Enabled DLQ.
//
// If `deadLetterQueue` is undefined,
// an SQS queue with default options will be defined for your Function.
DeadLetterQueueEnabled *bool `field:"optional" json:"deadLetterQueueEnabled" yaml:"deadLetterQueueEnabled"`
// The SNS topic to use as a DLQ.
//
// Note that if `deadLetterQueueEnabled` is set to `true`, an SQS queue will be created
// rather than an SNS topic. Using an SNS topic as a DLQ requires this property to be set explicitly.
DeadLetterTopic awssns.ITopic `field:"optional" json:"deadLetterTopic" yaml:"deadLetterTopic"`
// A description of the function.
Description *string `field:"optional" json:"description" yaml:"description"`
// Key-value pairs that Lambda caches and makes available for your Lambda functions.
//
// Use environment variables to apply configuration changes, such
// as test and production environment configurations, without changing your
// Lambda function source code.
Environment *map[string]*string `field:"optional" json:"environment" yaml:"environment"`
// The AWS KMS key that's used to encrypt your function's environment variables.
EnvironmentEncryption awskms.IKey `field:"optional" json:"environmentEncryption" yaml:"environmentEncryption"`
// The size of the function’s /tmp directory in MiB.
EphemeralStorageSize awscdk.Size `field:"optional" json:"ephemeralStorageSize" yaml:"ephemeralStorageSize"`
// Event sources for this function.
//
// You can also add event sources using `addEventSource`.
Events *[]awslambda.IEventSource `field:"optional" json:"events" yaml:"events"`
// The filesystem configuration for the lambda function.
Filesystem awslambda.FileSystem `field:"optional" json:"filesystem" yaml:"filesystem"`
// A name for the function.
FunctionName *string `field:"optional" json:"functionName" yaml:"functionName"`
// Initial policy statements to add to the created Lambda Role.
//
// You can call `addToRolePolicy` to the created lambda to add statements post creation.
InitialPolicy *[]awsiam.PolicyStatement `field:"optional" json:"initialPolicy" yaml:"initialPolicy"`
// Specify the version of CloudWatch Lambda insights to use for monitoring.
// See: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Lambda-Insights-Getting-Started-docker.html
//
InsightsVersion awslambda.LambdaInsightsVersion `field:"optional" json:"insightsVersion" yaml:"insightsVersion"`
// A list of layers to add to the function's execution environment.
//
// You can configure your Lambda function to pull in
// additional code during initialization in the form of layers. Layers are packages of libraries or other dependencies
// that can be used by multiple functions.
Layers *[]awslambda.ILayerVersion `field:"optional" json:"layers" yaml:"layers"`
// The number of days log events are kept in CloudWatch Logs.
//
// When updating
// this property, unsetting it doesn't remove the log retention policy. To
// remove the retention policy, set the value to `INFINITE`.
LogRetention awslogs.RetentionDays `field:"optional" json:"logRetention" yaml:"logRetention"`
// When log retention is specified, a custom resource attempts to create the CloudWatch log group.
//
// These options control the retry policy when interacting with CloudWatch APIs.
LogRetentionRetryOptions *awslambda.LogRetentionRetryOptions `field:"optional" json:"logRetentionRetryOptions" yaml:"logRetentionRetryOptions"`
// The IAM role for the Lambda function associated with the custom resource that sets the retention policy.
LogRetentionRole awsiam.IRole `field:"optional" json:"logRetentionRole" yaml:"logRetentionRole"`
// The amount of memory, in MB, that is allocated to your Lambda function.
//
// Lambda uses this value to proportionally allocate the amount of CPU
// power. For more information, see Resource Model in the AWS Lambda
// Developer Guide.
MemorySize *float64 `field:"optional" json:"memorySize" yaml:"memorySize"`
// Specify the configuration of Parameters and Secrets Extension.
// See: https://docs.aws.amazon.com/systems-manager/latest/userguide/ps-integration-lambda-extensions.html
//
ParamsAndSecrets awslambda.ParamsAndSecretsLayerVersion `field:"optional" json:"paramsAndSecrets" yaml:"paramsAndSecrets"`
// Enable profiling.
// See: https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html
//
Profiling *bool `field:"optional" json:"profiling" yaml:"profiling"`
// Profiling Group.
// See: https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html
//
ProfilingGroup awscodeguruprofiler.IProfilingGroup `field:"optional" json:"profilingGroup" yaml:"profilingGroup"`
// The maximum of concurrent executions you want to reserve for the function.
// See: https://docs.aws.amazon.com/lambda/latest/dg/concurrent-executions.html
//
ReservedConcurrentExecutions *float64 `field:"optional" json:"reservedConcurrentExecutions" yaml:"reservedConcurrentExecutions"`
// Lambda execution role.
//
// This is the role that will be assumed by the function upon execution.
// It controls the permissions that the function will have. The Role must
// be assumable by the 'lambda.amazonaws.com' service principal.
//
// The default Role automatically has permissions granted for Lambda execution. If you
// provide a Role, you must add the relevant AWS managed policies yourself.
//
// The relevant managed policies are "service-role/AWSLambdaBasicExecutionRole" and
// "service-role/AWSLambdaVPCAccessExecutionRole".
Role awsiam.IRole `field:"optional" json:"role" yaml:"role"`
// Sets the runtime management configuration for a function's version.
RuntimeManagementMode awslambda.RuntimeManagementMode `field:"optional" json:"runtimeManagementMode" yaml:"runtimeManagementMode"`
// The list of security groups to associate with the Lambda's network interfaces.
//
// Only used if 'vpc' is supplied.
SecurityGroups *[]awsec2.ISecurityGroup `field:"optional" json:"securityGroups" yaml:"securityGroups"`
// The function execution time (in seconds) after which Lambda terminates the function.
//
// Because the execution time affects cost, set this value
// based on the function's expected execution time.
Timeout awscdk.Duration `field:"optional" json:"timeout" yaml:"timeout"`
// Enable AWS X-Ray Tracing for Lambda Function.
Tracing awslambda.Tracing `field:"optional" json:"tracing" yaml:"tracing"`
// VPC network to place Lambda network interfaces.
//
// Specify this if the Lambda function needs to access resources in a VPC.
// This is required when `vpcSubnets` is specified.
Vpc awsec2.IVpc `field:"optional" json:"vpc" yaml:"vpc"`
// Where to place the network interfaces within the VPC.
//
// This requires `vpc` to be specified in order for interfaces to actually be
// placed in the subnets. If `vpc` is not specify, this will raise an error.
//
// Note: Internet access for Lambda Functions requires a NAT Gateway, so picking
// public subnets is not allowed (unless `allowPublicSubnet` is set to `true`).
VpcSubnets *awsec2.SubnetSelection `field:"optional" json:"vpcSubnets" yaml:"vpcSubnets"`
// 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`.
// See: https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/node-reusing-connections.html
//
AwsSdkConnectionReuse *bool `field:"optional" json:"awsSdkConnectionReuse" yaml:"awsSdkConnectionReuse"`
// Bundling options.
Bundling *BundlingOptions `field:"optional" json:"bundling" yaml:"bundling"`
// The path to the dependencies lock file (`yarn.lock`, `pnpm-lock.yaml` 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 (`yarn`, `pnpm` or `npm`) along with this lock file.
DepsLockFilePath *string `field:"optional" json:"depsLockFilePath" yaml:"depsLockFilePath"`
// Path to the entry file (JavaScript or TypeScript).
Entry *string `field:"optional" json:"entry" yaml:"entry"`
// The name of the exported handler in the entry file.
//
// The handler is prefixed with `index.` unless the specified handler value contains a `.`,
// in which case it is used as-is.
Handler *string `field:"optional" json:"handler" yaml:"handler"`
// The path to the directory containing project config files (`package.json` or `tsconfig.json`).
ProjectRoot *string `field:"optional" json:"projectRoot" yaml:"projectRoot"`
// The runtime environment.
//
// Only runtimes of the Node.js family are
// supported.
Runtime awslambda.Runtime `field:"optional" json:"runtime" yaml:"runtime"`
}
Properties for a NodejsFunction.
Example:
nodejs.NewNodejsFunction(this, jsii.String("my-handler"), &NodejsFunctionProps{
Bundling: &BundlingOptions{
Network: jsii.String("host"),
SecurityOpt: jsii.String("no-new-privileges"),
User: jsii.String("user:group"),
VolumesFrom: []*string{
jsii.String("777f7dc92da7"),
},
Volumes: []dockerVolume{
&dockerVolume{
HostPath: jsii.String("/host-path"),
ContainerPath: jsii.String("/container-path"),
},
},
},
})
type OutputFormat ¶ added in v2.7.0
type OutputFormat string
Output format for the generated JavaScript files.
Example:
nodejs.NewNodejsFunction(this, jsii.String("my-handler"), &NodejsFunctionProps{
Bundling: &BundlingOptions{
Minify: jsii.Boolean(true),
// minify code, defaults to false
SourceMap: jsii.Boolean(true),
// include source map, defaults to false
SourceMapMode: nodejs.SourceMapMode_INLINE,
// defaults to SourceMapMode.DEFAULT
SourcesContent: jsii.Boolean(false),
// do not include original source into source map, defaults to true
Target: jsii.String("es2020"),
// target environment for the generated JavaScript code
Loader: map[string]*string{
// Use the 'dataurl' loader for '.png' files
".png": jsii.String("dataurl"),
},
Define: map[string]*string{
// Replace strings during build time
"process.env.API_KEY": JSON.stringify(jsii.String("xxx-xxxx-xxx")),
"process.env.PRODUCTION": JSON.stringify(jsii.Boolean(true)),
"process.env.NUMBER": JSON.stringify(jsii.Number(123)),
},
LogLevel: nodejs.LogLevel_SILENT,
// defaults to LogLevel.WARNING
KeepNames: jsii.Boolean(true),
// defaults to false
Tsconfig: jsii.String("custom-tsconfig.json"),
// use custom-tsconfig.json instead of default,
Metafile: jsii.Boolean(true),
// include meta file, defaults to false
Banner: jsii.String("/* comments */"),
// requires esbuild >= 0.9.0, defaults to none
Footer: jsii.String("/* comments */"),
// requires esbuild >= 0.9.0, defaults to none
Charset: nodejs.Charset_UTF8,
// do not escape non-ASCII characters, defaults to Charset.ASCII
Format: nodejs.OutputFormat_ESM,
// ECMAScript module output format, defaults to OutputFormat.CJS (OutputFormat.ESM requires Node.js 14.x)
MainFields: []*string{
jsii.String("module"),
jsii.String("main"),
},
// prefer ECMAScript versions of dependencies
Inject: []*string{
jsii.String("./my-shim.js"),
jsii.String("./other-shim.js"),
},
// allows to automatically replace a global variable with an import from another file
EsbuildArgs: map[string]interface{}{
// Pass additional arguments to esbuild
"--log-limit": jsii.String("0"),
"--splitting": jsii.Boolean(true),
},
},
})
const ( // CommonJS. OutputFormat_CJS OutputFormat = "CJS" // ECMAScript module. // // Requires a running environment that supports `import` and `export` syntax. OutputFormat_ESM OutputFormat = "ESM" )
type SourceMapMode ¶
type SourceMapMode string
SourceMap mode for esbuild.
Example:
nodejs.NewNodejsFunction(this, jsii.String("my-handler"), &NodejsFunctionProps{
Bundling: &BundlingOptions{
Minify: jsii.Boolean(true),
// minify code, defaults to false
SourceMap: jsii.Boolean(true),
// include source map, defaults to false
SourceMapMode: nodejs.SourceMapMode_INLINE,
// defaults to SourceMapMode.DEFAULT
SourcesContent: jsii.Boolean(false),
// do not include original source into source map, defaults to true
Target: jsii.String("es2020"),
// target environment for the generated JavaScript code
Loader: map[string]*string{
// Use the 'dataurl' loader for '.png' files
".png": jsii.String("dataurl"),
},
Define: map[string]*string{
// Replace strings during build time
"process.env.API_KEY": JSON.stringify(jsii.String("xxx-xxxx-xxx")),
"process.env.PRODUCTION": JSON.stringify(jsii.Boolean(true)),
"process.env.NUMBER": JSON.stringify(jsii.Number(123)),
},
LogLevel: nodejs.LogLevel_SILENT,
// defaults to LogLevel.WARNING
KeepNames: jsii.Boolean(true),
// defaults to false
Tsconfig: jsii.String("custom-tsconfig.json"),
// use custom-tsconfig.json instead of default,
Metafile: jsii.Boolean(true),
// include meta file, defaults to false
Banner: jsii.String("/* comments */"),
// requires esbuild >= 0.9.0, defaults to none
Footer: jsii.String("/* comments */"),
// requires esbuild >= 0.9.0, defaults to none
Charset: nodejs.Charset_UTF8,
// do not escape non-ASCII characters, defaults to Charset.ASCII
Format: nodejs.OutputFormat_ESM,
// ECMAScript module output format, defaults to OutputFormat.CJS (OutputFormat.ESM requires Node.js 14.x)
MainFields: []*string{
jsii.String("module"),
jsii.String("main"),
},
// prefer ECMAScript versions of dependencies
Inject: []*string{
jsii.String("./my-shim.js"),
jsii.String("./other-shim.js"),
},
// allows to automatically replace a global variable with an import from another file
EsbuildArgs: map[string]interface{}{
// Pass additional arguments to esbuild
"--log-limit": jsii.String("0"),
"--splitting": jsii.Boolean(true),
},
},
})
See: https://esbuild.github.io/api/#sourcemap
const ( // Default sourceMap mode - will generate a .js.map file alongside any generated .js file and add a special //# sourceMappingURL= comment to the bottom of the .js file pointing to the .js.map file. SourceMapMode_DEFAULT SourceMapMode = "DEFAULT" // External sourceMap mode - If you want to omit the special //# sourceMappingURL= comment from the generated .js file but you still want to generate the .js.map files. SourceMapMode_EXTERNAL SourceMapMode = "EXTERNAL" // Inline sourceMap mode - If you want to insert the entire source map into the .js file instead of generating a separate .js.map file. SourceMapMode_INLINE SourceMapMode = "INLINE" // Both sourceMap mode - If you want to have the effect of both inline and external simultaneously. SourceMapMode_BOTH SourceMapMode = "BOTH" )