Interface GuSnsLambdaProps

Configuration options for the [[GuSnsLambda]] pattern.

For all lambda function configuration options, see [[GuFunctionProps]].

The existingSnsTopic property can be used to inherit or reference an SNS topic which has been created outside of cdk. If this property is omitted, the [[GuSnsLambda]] pattern will create a new topic. For more details and example usage, see [[ExistingSnsTopic]].

It is advisable to configure an alarm based on the lambda's error percentage. To do this, add the monitoringConfiguration property. The required properties for this are:

monitoringConfiguration: {
  toleratedErrorPercentage: <sensible_error_percentage_threshold>,
  snsTopicName: "my-topic-for-cloudwatch-alerts",
}

Other alarm properties (e.g. alarm name and description) will be pre-populated with sensible defaults. For a full list of optional properties, see [[GuLambdaErrorPercentageMonitoringProps]].

If your team do not use CloudWatch, it's possible to opt-out with the following configuration:

 monitoringConfiguration: { noMonitoring: true } as NoMonitoring

interface GuSnsLambdaProps {
    adotInstrumentation?: AdotInstrumentationConfig;
    allowAllIpv6Outbound?: boolean;
    allowAllOutbound?: boolean;
    allowPublicSubnet?: boolean;
    app: string;
    applicationLogLevel?: string;
    applicationLogLevelV2?: ApplicationLogLevel;
    architecture?: Architecture;
    bucketNamePath?: string;
    codeSigningConfig?: ICodeSigningConfig;
    currentVersionOptions?: VersionOptions;
    deadLetterQueue?: IQueue;
    deadLetterQueueEnabled?: boolean;
    deadLetterTopic?: ITopic;
    description?: string;
    enableVersioning?: boolean;
    environment?: { [key: string]: string };
    environmentEncryption?: IKey;
    ephemeralStorageSize?: Size;
    events?: IEventSource[];
    existingSnsTopic?: ExistingSnsTopic;
    fileName: string;
    filesystem?: FileSystem;
    functionName?: string;
    handler: string;
    initialPolicy?: PolicyStatement[];
    insightsVersion?: LambdaInsightsVersion;
    ipv6AllowedForDualStack?: boolean;
    layers?: ILayerVersion[];
    logFormat?: string;
    loggingFormat?: LoggingFormat;
    logGroup?: ILogGroup;
    logRetention?: RetentionDays;
    logRetentionRetryOptions?: LogRetentionRetryOptions;
    logRetentionRole?: IRole;
    maxEventAge?: Duration;
    memorySize?: number;
    monitoringConfiguration:
        | GuLambdaErrorPercentageMonitoringProps
        | NoMonitoring;
    onFailure?: IDestination;
    onSuccess?: IDestination;
    paramsAndSecrets?: ParamsAndSecretsLayerVersion;
    profiling?: boolean;
    profilingGroup?: IProfilingGroup;
    recursiveLoop?: RecursiveLoop;
    reservedConcurrentExecutions?: number;
    retryAttempts?: number;
    role?: IRole;
    runtime: Runtime;
    runtimeManagementMode?: RuntimeManagementMode;
    securityGroups?: ISecurityGroup[];
    snapStart?: SnapStartConf;
    systemLogLevel?: string;
    systemLogLevelV2?: SystemLogLevel;
    throttlingMonitoring?: GuLambdaThrottlingMonitoringProps;
    timeout?: Duration;
    tracing?: Tracing;
    vpc?: IVpc;
    vpcSubnets?: SubnetSelection;
    withoutArtifactUpload?: boolean;
    withoutFilePrefix?: boolean;
}

Hierarchy

Omit<GuFunctionProps, "errorPercentageMonitoring">
- GuSnsLambdaProps

Index

Properties

adotInstrumentation? allowAllIpv6Outbound? allowAllOutbound? allowPublicSubnet? app applicationLogLevel? applicationLogLevelV2? architecture? bucketNamePath? codeSigningConfig? currentVersionOptions? deadLetterQueue? deadLetterQueueEnabled? deadLetterTopic? description? enableVersioning? environment? environmentEncryption? ephemeralStorageSize? events? existingSnsTopic? fileName filesystem? functionName? handler initialPolicy? insightsVersion? ipv6AllowedForDualStack? layers? logFormat? loggingFormat? logGroup? logRetention? logRetentionRetryOptions? logRetentionRole? maxEventAge? memorySize? monitoringConfiguration onFailure? onSuccess? paramsAndSecrets? profiling? profilingGroup? recursiveLoop? reservedConcurrentExecutions? retryAttempts? role? runtime runtimeManagementMode? securityGroups? snapStart? systemLogLevel? systemLogLevelV2? throttlingMonitoring? timeout? tracing? vpc? vpcSubnets? withoutArtifactUpload? withoutFilePrefix?

Properties

`Optional` `Readonly`adotInstrumentation

adotInstrumentation?: AdotInstrumentationConfig

Specify the configuration of AWS Distro for OpenTelemetry (ADOT) instrumentation

See

https://aws-otel.github.io/docs/getting-started/lambda

Default

- No ADOT instrumentation

`Optional` `Readonly`allowAllIpv6Outbound

allowAllIpv6Outbound?: boolean

Whether to allow the Lambda to send all ipv6 network traffic

If set to true, there will only be a single egress rule which allows all outbound ipv6 traffic. If set to false, you must individually add traffic rules to allow the Lambda to connect to network targets using ipv6.

Do not specify this property if the securityGroups or securityGroup property is set. Instead, configure allowAllIpv6Outbound directly on the security group.

Default

false

`Optional` `Readonly`allowAllOutbound

allowAllOutbound?: boolean

Whether to allow the Lambda to send all network traffic (except ipv6)

If set to false, you must individually add traffic rules to allow the Lambda to connect to network targets.

Do not specify this property if the securityGroups or securityGroup property is set. Instead, configure allowAllOutbound directly on the security group.

Default

true

`Optional` `Readonly`allowPublicSubnet

allowPublicSubnet?: boolean

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

Default

false

app

app: string

`Optional` `Readonly`applicationLogLevel

applicationLogLevel?: string

Sets the application log level for the function.

Deprecated

Use applicationLogLevelV2 as a property instead.

Default

"INFO"

`Optional` `Readonly`applicationLogLevelV2

applicationLogLevelV2?: ApplicationLogLevel

Sets the application log level for the function.

Default

ApplicationLogLevel.INFO

`Optional` `Readonly`architecture

architecture?: Architecture

The system architectures compatible with this lambda function.

Default

Architecture.X86_64

`Optional`bucketNamePath

bucketNamePath?: string

SSM parameter for the S3 bucket that contains your lambda file.

Typically you should not override this but you may need to if, for example, you are referencing a file that is shared across many apps and/or AWS accounts.

Default Value

[[GuDistributionBucketParameter]]

`Optional` `Readonly`codeSigningConfig

codeSigningConfig?: ICodeSigningConfig

Code signing config associated with this function

Default

- Not Sign the Code

`Optional` `Readonly`currentVersionOptions

currentVersionOptions?: VersionOptions

Options for the lambda.Version resource automatically created by the fn.currentVersion method.

Default

default options as described in VersionOptions

`Optional` `Readonly`deadLetterQueue

deadLetterQueue?: IQueue

The SQS queue to use if DLQ is enabled. If SNS topic is desired, specify deadLetterTopic property instead.

Default

SQS queue with 14 day retention period if deadLetterQueueEnabled is true

`Optional` `Readonly`deadLetterQueueEnabled

deadLetterQueueEnabled?: boolean

Enabled DLQ. If deadLetterQueue is undefined, an SQS queue with default options will be defined for your Function.

Default

false unless deadLetterQueue is set, which implies DLQ is enabled.

`Optional` `Readonly`deadLetterTopic

deadLetterTopic?: ITopic

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.

Default

- no SNS topic

`Optional` `Readonly`description

description?: string

A description of the function.

Default

- No description.

`Optional`enableVersioning

enableVersioning?: boolean

Create a new Lambda version and alias. This is only necessary if you want to use features which rely on versioning (e.g. SnapStart or Provisioned Concurrency).

If you enable versioning you must ensure that your Lambda function is updated whenever a new build is deployed via CloudFormation. The simplest way to do this is to include the build number in the fileName prop.

`Optional` `Readonly`environment

environment?: { [key: string]: string }

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.

Default

- No environment variables.

`Optional` `Readonly`environmentEncryption

environmentEncryption?: IKey

The AWS KMS key that's used to encrypt your function's environment variables.

Default

- AWS Lambda creates and uses an AWS managed customer master key (CMK).

`Optional` `Readonly`ephemeralStorageSize

ephemeralStorageSize?: Size

The size of the function’s /tmp directory in MiB.

Default

512 MiB

`Optional` `Readonly`events

events?: IEventSource[]

Event sources for this function.

You can also add event sources using addEventSource.

Default

- No event sources.

`Optional`existingSnsTopic

existingSnsTopic?: ExistingSnsTopic

fileName

fileName: string

The filename for an executable package within the bucket [[GuDistributionBucketParameter]]. We'll look for fileName on the path "bucket/stack/stage/app/".

`Optional` `Readonly`filesystem

filesystem?: FileSystem

The filesystem configuration for the lambda function

Default

- will not mount any filesystem

`Optional` `Readonly`functionName

functionName?: string

A name for the function.

Default

- AWS CloudFormation generates a unique physical ID and uses that
ID for the function's name. For more information, see Name Type.

`Readonly`handler

handler: string

The name of the method within your code that Lambda calls to execute your function. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see https://docs.aws.amazon.com/lambda/latest/dg/foundation-progmodel.html.

Use Handler.FROM_IMAGE when defining a function from a Docker image.

NOTE: If you specify your source code as inline text by specifying the ZipFile property within the Code property, specify index.function_name as the handler.

`Optional` `Readonly`initialPolicy

initialPolicy?: PolicyStatement[]

Initial policy statements to add to the created Lambda Role.

You can call addToRolePolicy to the created lambda to add statements post creation.

Default

- No policy statements are added to the created Lambda role.

`Optional` `Readonly`insightsVersion

insightsVersion?: LambdaInsightsVersion

Specify the version of CloudWatch Lambda insights to use for monitoring

See

https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Lambda-Insights.html

When used with DockerImageFunction or DockerImageCode, the Docker image should have the Lambda insights agent installed.

https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Lambda-Insights-Getting-Started-docker.html

Default

- No Lambda Insights

`Optional` `Readonly`ipv6AllowedForDualStack

ipv6AllowedForDualStack?: boolean

Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets.

Only used if 'vpc' is supplied.

Default

false

`Optional` `Readonly`layers

layers?: ILayerVersion[]

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.

Default

- No layers.

`Optional` `Readonly`logFormat

logFormat?: string

Sets the logFormat for the function.

Deprecated

Use loggingFormat as a property instead.

Default

"Text"

`Optional` `Readonly`loggingFormat

loggingFormat?: LoggingFormat

Sets the loggingFormat for the function.

Default

LoggingFormat.TEXT

`Optional` `Readonly`logGroup

logGroup?: ILogGroup

The log group the function sends logs to.

By default, Lambda functions send logs to an automatically created default log group named /aws/lambda/<function name>. However you cannot change the properties of this auto-created log group using the AWS CDK, e.g. you cannot set a different log retention.

Use the logGroup property to create a fully customizable LogGroup ahead of time, and instruct the Lambda function to send logs to it.

Providing a user-controlled log group was rolled out to commercial regions on 2023-11-16. If you are deploying to another type of region, please check regional availability first.

Default

/aws/lambda/${this.functionName} - default log group created by Lambda

`Optional` `Readonly`logRetention

logRetention?: RetentionDays

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.

This is a legacy API and we strongly recommend you move away from it if you can. Instead create a fully customizable log group with logs.LogGroup and use the logGroup property to instruct the Lambda function to send logs to it. Migrating from logRetention to logGroup will cause the name of the log group to change. Users and code and referencing the name verbatim will have to adjust.

In AWS CDK code, you can access the log group name directly from the LogGroup construct:

import * as logs from 'aws-cdk-lib/aws-logs';

declare const myLogGroup: logs.LogGroup;
myLogGroup.logGroupName;

Default

logs.RetentionDays.INFINITE

`Optional` `Readonly`logRetentionRetryOptions

logRetentionRetryOptions?: LogRetentionRetryOptions

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.

This is a legacy API and we strongly recommend you migrate to logGroup if you can. logGroup allows you to create a fully customizable log group and instruct the Lambda function to send logs to it.

Default

- Default AWS SDK retry options.

`Optional` `Readonly`logRetentionRole

logRetentionRole?: IRole

The IAM role for the Lambda function associated with the custom resource that sets the retention policy.

Default

- A new role is created.

`Optional` `Readonly`maxEventAge

maxEventAge?: Duration

The maximum age of a request that Lambda sends to a function for processing.

Minimum: 60 seconds Maximum: 6 hours

Default

Duration.hours(6)

`Optional` `Readonly`memorySize

memorySize?: number

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.

Default

monitoringConfiguration

monitoringConfiguration: GuLambdaErrorPercentageMonitoringProps | NoMonitoring

`Optional` `Readonly`onFailure

onFailure?: IDestination

The destination for failed invocations.

Default

- no destination

`Optional` `Readonly`onSuccess

onSuccess?: IDestination

The destination for successful invocations.

Default

- no destination

`Optional` `Readonly`paramsAndSecrets

paramsAndSecrets?: ParamsAndSecretsLayerVersion

Specify the configuration of Parameters and Secrets Extension

See

Default

- No Parameters and Secrets Extension

`Optional` `Readonly`profiling

profiling?: boolean

Enable profiling.

See

https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html

Default

- No profiling.

`Optional` `Readonly`profilingGroup

profilingGroup?: IProfilingGroup

Profiling Group.

See

https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html

Default

A new profiling group will be created if profiling is set.

`Optional` `Readonly`recursiveLoop

recursiveLoop?: RecursiveLoop

Sets the Recursive Loop Protection for Lambda Function. It lets Lambda detect and terminate unintended recursive loops.

Default

RecursiveLoop.Terminate

`Optional` `Readonly`reservedConcurrentExecutions

reservedConcurrentExecutions?: number

The maximum of concurrent executions you want to reserve for the function.

Default

- No specific limit - account limit.

See

https://docs.aws.amazon.com/lambda/latest/dg/concurrent-executions.html

`Optional` `Readonly`retryAttempts

retryAttempts?: number

The maximum number of times to retry when the function returns an error.

Minimum: 0 Maximum: 2

Default

`Optional` `Readonly`role

role?: IRole

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

Default

A unique role will be generated for this lambda function. Both supplied and generated roles can always be changed by calling addToRolePolicy.

`Readonly`runtime

runtime: Runtime

The runtime environment for the Lambda function that you are uploading. For valid values, see the Runtime property in the AWS Lambda Developer Guide.

Use Runtime.FROM_IMAGE when defining a function from a Docker image.

`Optional` `Readonly`runtimeManagementMode

runtimeManagementMode?: RuntimeManagementMode

Sets the runtime management configuration for a function's version.

Default

Auto

`Optional` `Readonly`securityGroups

securityGroups?: ISecurityGroup[]

The list of security groups to associate with the Lambda's network interfaces.

Only used if 'vpc' is supplied.

Default

- If the function is placed within a VPC and a security group is
not specified, either by this or securityGroup prop, a dedicated security
group will be created for this function.

`Optional` `Readonly`snapStart

snapStart?: SnapStartConf

Enable SnapStart for Lambda Function. SnapStart is currently supported for Java 11, Java 17, Python 3.12, Python 3.13, and .NET 8 runtime

Default

- No snapstart

`Optional` `Readonly`systemLogLevel

systemLogLevel?: string

Sets the system log level for the function.

Deprecated

Use systemLogLevelV2 as a property instead.

Default

"INFO"

`Optional` `Readonly`systemLogLevelV2

systemLogLevelV2?: SystemLogLevel

Sets the system log level for the function.

Default

SystemLogLevel.INFO

`Optional`throttlingMonitoring

throttlingMonitoring?: GuLambdaThrottlingMonitoringProps

Alarm if throttling occurs. Note, it is also worth considering a concurrency limit (the reservedConcurrentExecutions prop) if you are concerned about throttling.

See

https://docs.aws.amazon.com/lambda/latest/dg/concurrent-executions.html

`Optional` `Readonly`timeout

timeout?: Duration

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.

Default

Duration.seconds(3)

`Optional` `Readonly`tracing

tracing?: Tracing

Enable AWS X-Ray Tracing for Lambda Function.

Default

Tracing.Disabled

`Optional` `Readonly`vpc

vpc?: IVpc

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.

Default

- Function is not placed within a VPC.

`Optional` `Readonly`vpcSubnets

vpcSubnets?: SubnetSelection

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

Default

- the Vpc default strategy if not specified

`Optional`withoutArtifactUpload

withoutArtifactUpload?: boolean

Set to true this informs consumers of this function that upload is managed elsewhere by DevX.

This is used by RiffRaffYamlFileExperimental to skip generating an uploadLambda step.

`Optional`withoutFilePrefix

withoutFilePrefix?: boolean

Set to true to use the filename without the stage/stack/app prefix.

Typically you should not override this but you may need to if, for example, you are referencing a file that is shared across many apps and/or AWS accounts.

Interface GuSnsLambdaProps

Hierarchy

Index

Properties

Properties

Optional ReadonlyadotInstrumentation

See

Default

Optional ReadonlyallowAllIpv6Outbound

Default

Optional ReadonlyallowAllOutbound

Default

Optional ReadonlyallowPublicSubnet

See

Default

app

Optional ReadonlyapplicationLogLevel

Deprecated

Default

Optional ReadonlyapplicationLogLevelV2

Default

Optional Readonlyarchitecture

Default

OptionalbucketNamePath

Default Value

Optional ReadonlycodeSigningConfig

Default

Optional ReadonlycurrentVersionOptions

Default

Optional ReadonlydeadLetterQueue

Default

Optional ReadonlydeadLetterQueueEnabled

Default

Optional ReadonlydeadLetterTopic

Default

Optional Readonlydescription

Default

OptionalenableVersioning

Optional Readonlyenvironment

Default

Optional ReadonlyenvironmentEncryption

Default

Optional ReadonlyephemeralStorageSize

Default

Optional Readonlyevents

Default

OptionalexistingSnsTopic

fileName

Optional Readonlyfilesystem

Default

Optional ReadonlyfunctionName

Default

Readonlyhandler

Optional ReadonlyinitialPolicy

Default

Optional ReadonlyinsightsVersion

See

Default

Optional Readonlyipv6AllowedForDualStack

Default

Optional Readonlylayers

Default

Optional ReadonlylogFormat

Deprecated

Default

Optional ReadonlyloggingFormat

Default

Optional ReadonlylogGroup

Default

Optional ReadonlylogRetention

Default

Optional ReadonlylogRetentionRetryOptions

Default

Optional ReadonlylogRetentionRole

Default

Optional ReadonlymaxEventAge

Default

Optional ReadonlymemorySize

Default

monitoringConfiguration

`Optional` `Readonly`adotInstrumentation

`Optional` `Readonly`allowAllIpv6Outbound

`Optional` `Readonly`allowAllOutbound

`Optional` `Readonly`allowPublicSubnet

`Optional` `Readonly`applicationLogLevel

`Optional` `Readonly`applicationLogLevelV2

`Optional` `Readonly`architecture

`Optional`bucketNamePath

`Optional` `Readonly`codeSigningConfig

`Optional` `Readonly`currentVersionOptions

`Optional` `Readonly`deadLetterQueue

`Optional` `Readonly`deadLetterQueueEnabled

`Optional` `Readonly`deadLetterTopic

`Optional` `Readonly`description

`Optional`enableVersioning

`Optional` `Readonly`environment

`Optional` `Readonly`environmentEncryption

`Optional` `Readonly`ephemeralStorageSize

`Optional` `Readonly`events

`Optional`existingSnsTopic

`Optional` `Readonly`filesystem

`Optional` `Readonly`functionName

`Readonly`handler

`Optional` `Readonly`initialPolicy

`Optional` `Readonly`insightsVersion

`Optional` `Readonly`ipv6AllowedForDualStack

`Optional` `Readonly`layers

`Optional` `Readonly`logFormat

`Optional` `Readonly`loggingFormat

`Optional` `Readonly`logGroup

`Optional` `Readonly`logRetention

`Optional` `Readonly`logRetentionRetryOptions

`Optional` `Readonly`logRetentionRole

`Optional` `Readonly`maxEventAge

`Optional` `Readonly`memorySize

`Optional` `Readonly`onFailure

`Optional` `Readonly`onSuccess

`Optional` `Readonly`paramsAndSecrets

`Optional` `Readonly`profiling

`Optional` `Readonly`profilingGroup

`Optional` `Readonly`recursiveLoop

`Optional` `Readonly`reservedConcurrentExecutions

`Optional` `Readonly`retryAttempts

`Optional` `Readonly`role

`Readonly`runtime

`Optional` `Readonly`runtimeManagementMode

`Optional` `Readonly`securityGroups

`Optional` `Readonly`snapStart

`Optional` `Readonly`systemLogLevel

`Optional` `Readonly`systemLogLevelV2

`Optional`throttlingMonitoring

`Optional` `Readonly`timeout

`Optional` `Readonly`tracing

`Optional` `Readonly`vpc

`Optional` `Readonly`vpcSubnets

`Optional`withoutArtifactUpload

`Optional`withoutFilePrefix