FunctionBuilder (FsCDK)

FunctionBuilder Type

Namespace: FsCDK
Assembly: FsCDK.dll
Base Type: obj

Constructors

Constructor Description

Constructor	Description
`FunctionBuilder(name)` Full Usage: `FunctionBuilder(name)` Parameters: name : `string` Returns: `FunctionBuilder`	name : `string` Returns: `FunctionBuilder`


                
                  
                    
                      FunctionBuilder(name)

Full Usage: FunctionBuilder(name)

Parameters:

name : string

Returns: FunctionBuilder

name : string

Returns: FunctionBuilder

Instance members

Instance member	Description
`addEventSource eventSource` Full Usage: `addEventSource eventSource` Parameters: eventSource : `IEventSource` - Event source. Returns: `FunctionConfig`	Adds a single event source to the internal event sources list. Prefer using `event` unless you need to target the internal list directly. eventSource : `IEventSource` Event source. Returns: `FunctionConfig`
`addEventSourceMapping eventSourceMapping` Full Usage: `addEventSourceMapping eventSourceMapping` Parameters: eventSourceMapping : `string * IEventSourceMappingOptions` - Tuple of construct id and mapping options. Returns: `FunctionConfig`	Adds a single event source mapping. eventSourceMapping : `string * IEventSourceMappingOptions` Tuple of construct id and mapping options. Returns: `FunctionConfig`
`addEventSourceMappings eventSourceMapping` Full Usage: `addEventSourceMappings eventSourceMapping` Parameters: eventSourceMapping : `(string * IEventSourceMappingOptions) list` - List of tuples of construct id and mapping options. Returns: `FunctionConfig`	Sets the event source mappings list to the provided list. eventSourceMapping : `(string * IEventSourceMappingOptions) list` List of tuples of construct id and mapping options. Returns: `FunctionConfig`
`addEventSources eventSource` Full Usage: `addEventSources eventSource` Parameters: eventSource : `IEventSource list` - List of event sources. Returns: `FunctionConfig`	Sets the event source mappings list (used internally) to the provided list. This internal list is separate from the public `events` list used by CDK `FunctionProps.Events`. Prefer using `events`/`event` unless you need explicit control here. eventSource : `IEventSource list` List of event sources. Returns: `FunctionConfig`
`addPermission permissions` Full Usage: `addPermission permissions` Parameters: permissions : `IPermission` - Permission to add. Returns: `FunctionConfig`	Adds a single permission to the permissions list. permissions : `IPermission` Permission to add. Returns: `FunctionConfig`
`addPermissions permissions` Full Usage: `addPermissions permissions` Parameters: permissions : `IPermission list` - List of permissions. Returns: `FunctionConfig`	Sets the permissions list to the provided list (replaces existing). permissions : `IPermission list` List of permissions. Returns: `FunctionConfig`
`addRolePolicyStatement statements` Full Usage: `addRolePolicyStatement statements` Parameters: statements : `PolicyStatement` - Policy statement. Returns: `FunctionConfig`	Adds a single role policy statement. statements : `PolicyStatement` Policy statement. Returns: `FunctionConfig`
`addRolePolicyStatements statements` Full Usage: `addRolePolicyStatements statements` Parameters: statements : `PolicyStatement list` - List of policy statements. Returns: `FunctionConfig`	Sets the role policy statements list to the provided list (replaces existing). statements : `PolicyStatement list` List of policy statements. Returns: `FunctionConfig`
`addUrlOption options` Full Usage: `addUrlOption options` Parameters: options : `IFunctionUrlOptions` - Function URL options. Returns: `FunctionConfig`	Adds a single function URL options item to the options list. options : `IFunctionUrlOptions` Function URL options. Returns: `FunctionConfig`
`addUrlOptions options` Full Usage: `addUrlOptions options` Parameters: options : `IFunctionUrlOptions list` - List of function URL options. Returns: `FunctionConfig`	Sets the function URL options list (replaces any previously set options). options : `IFunctionUrlOptions list` List of function URL options. Returns: `FunctionConfig`
`adotInstrumentation adot` Full Usage: `adotInstrumentation adot` Parameters: adot : `IAdotInstrumentationConfig` - ADOT instrumentation configuration. Returns: `FunctionConfig`	Enables AWS Distro for OpenTelemetry (ADOT) instrumentation for the Lambda function. adot : `IAdotInstrumentationConfig` ADOT instrumentation configuration. Returns: `FunctionConfig`
`allowAllIpv6Outbound allow` Full Usage: `allowAllIpv6Outbound allow` Parameters: allow : `bool` - True to allow all IPv6 outbound traffic. Returns: `FunctionConfig`	Allows all outbound IPv6 traffic for the Lambda function. allow : `bool` True to allow all IPv6 outbound traffic. Returns: `FunctionConfig`
`allowAllOutbound allow` Full Usage: `allowAllOutbound allow` Parameters: allow : `bool` - True to allow all outbound traffic. Returns: `FunctionConfig`	Allows the Lambda function to make outbound network calls. allow : `bool` True to allow all outbound traffic. Returns: `FunctionConfig`
`allowPublicSubnet allow` Full Usage: `allowPublicSubnet allow` Parameters: allow : `bool` - True to allow placement in public subnets. Returns: `FunctionConfig`	Allows the Lambda function to be placed in public subnets. allow : `bool` True to allow placement in public subnets. Returns: `FunctionConfig`
`applicationLogLevelV2 level` Full Usage: `applicationLogLevelV2 level` Parameters: level : `ApplicationLogLevel` - Application log level. Returns: `FunctionConfig`	Sets the application log level for the function (CloudWatch Logs V2). level : `ApplicationLogLevel` Application log level. Returns: `FunctionConfig`
`architecture arch` Full Usage: `architecture arch` Parameters: arch : `Architecture` - CPU architecture. Returns: `FunctionConfig`	Sets the CPU architecture for the function (e.g., x86_64 or arm64). arch : `Architecture` CPU architecture. Returns: `FunctionConfig`
`asyncInvokeOption options` Full Usage: `asyncInvokeOption options` Parameters: options : `IEventInvokeConfigOptions` - Async invoke option. Returns: `FunctionConfig`	Adds a single asynchronous invocation option. options : `IEventInvokeConfigOptions` Async invoke option. Returns: `FunctionConfig`
`asyncInvokeOptions options` Full Usage: `asyncInvokeOptions options` Parameters: options : `IEventInvokeConfigOptions list` - List of async invoke configuration options. Returns: `FunctionConfig`	Sets the asynchronous invocation options list (replaces existing). options : `IEventInvokeConfigOptions list` List of async invoke configuration options. Returns: `FunctionConfig`
`autoAddPowertools value` Full Usage: `autoAddPowertools value` Parameters: value : `bool` - True to auto-add Powertools, false to skip. Returns: `FunctionConfig`	Controls automatic Lambda Powertools layer addition. Default: true (Yan Cui recommendation). Set to false to disable Powertools auto-addition. value : `bool` True to auto-add Powertools, false to skip. Returns: `FunctionConfig`
`autoCreateDLQ value` Full Usage: `autoCreateDLQ value` Parameters: value : `bool` - True to enable, false to disable automatic DLQ creation. Returns: `FunctionConfig`	Controls automatic DLQ creation. Default: true (Yan Cui recommendation). Set to false to disable auto-DLQ creation. value : `bool` True to enable, false to disable automatic DLQ creation. Returns: `FunctionConfig`
`code path` Full Usage: `code path` Parameters: path : `Code` - The Code object. Returns: `FunctionConfig`	Sets the code source from a Code object. path : `Code` The Code object. Returns: `FunctionConfig`
`code path options` Full Usage: `code path options` Parameters: path : `string` - The path to the code asset. options : `AssetOptions` - Asset options. Returns: `FunctionConfig`	Sets the code source from a local asset with options. path : `string` The path to the code asset. options : `AssetOptions` Asset options. Returns: `FunctionConfig`
`code path` Full Usage: `code path` Parameters: path : `string` - The path to the code asset. Returns: `FunctionConfig`	Sets the code source from a local asset. path : `string` The path to the code asset. Returns: `FunctionConfig`
`codeSigningConfig csc` Full Usage: `codeSigningConfig csc` Parameters: csc : `ICodeSigningConfig` - Code signing configuration. Returns: `FunctionConfig`	Attaches a code signing configuration to the function. csc : `ICodeSigningConfig` Code signing configuration. Returns: `FunctionConfig`
`this.Combine` Full Usage: `this.Combine` Parameters: state1 : `FunctionConfig` state2 : `FunctionConfig` Returns: `FunctionConfig`	state1 : `FunctionConfig` state2 : `FunctionConfig` Returns: `FunctionConfig`
`constructId id` Full Usage: `constructId id` Parameters: id : `string` - The construct ID. Returns: `FunctionConfig`	Sets the construct ID for the Lambda function. id : `string` The construct ID. Returns: `FunctionConfig`
`currentVersionOptions options` Full Usage: `currentVersionOptions options` Parameters: options : `IVersionOptions` - Version options. Returns: `FunctionConfig`	Configures options for the current version of the function. options : `IVersionOptions` Version options. Returns: `FunctionConfig`
`deadLetterQueue queue` Full Usage: `deadLetterQueue queue` Parameters: queue : `IQueue` - Dead-letter queue. Returns: `FunctionConfig`	Sets an SQS dead-letter queue for asynchronous invocation failures. queue : `IQueue` Dead-letter queue. Returns: `FunctionConfig`
`deadLetterQueueEnabled value` Full Usage: `deadLetterQueueEnabled value` Parameters: value : `bool` - True to enable the DLQ, false to disable. Returns: `FunctionConfig`	Enables or disables use of the configured dead-letter queue. value : `bool` True to enable the DLQ, false to disable. Returns: `FunctionConfig`
`deadLetterTopic topic` Full Usage: `deadLetterTopic topic` Parameters: topic : `ITopic` - SNS topic. Returns: `FunctionConfig`	Sets a dead-letter SNS topic for asynchronous invocation failures. topic : `ITopic` SNS topic. Returns: `FunctionConfig`
`this.Delay` Full Usage: `this.Delay` Parameters: f : `unit -> FunctionConfig` Returns: `FunctionConfig` Modifiers: inline	f : `unit -> FunctionConfig` Returns: `FunctionConfig`
`description desc` Full Usage: `description desc` Parameters: desc : `string` - The function description. Returns: `FunctionConfig`	Sets the description for the Lambda function. desc : `string` The function description. Returns: `FunctionConfig`
`dockerImageCode directory ?cmd ?entrypoint` Full Usage: `dockerImageCode directory ?cmd ?entrypoint` Parameters: directory : `string` - The directory containing the Dockerfile. ?cmd : `string[]` - Optional CMD for the Docker image. ?entrypoint : `string[]` - Optional ENTRYPOINT for the Docker image. Returns: `FunctionConfig`	Sets the code source from a Docker image. directory : `string` The directory containing the Dockerfile. ?cmd : `string[]` Optional CMD for the Docker image. ?entrypoint : `string[]` Optional ENTRYPOINT for the Docker image. Returns: `FunctionConfig`
`envVar key value` Full Usage: `envVar key value` Parameters: key : `string` - The environment variable key. value : `string` - The environment variable value. Returns: `FunctionConfig`	Adds a single environment variable. key : `string` The environment variable key. value : `string` The environment variable value. Returns: `FunctionConfig`
`environment env` Full Usage: `environment env` Parameters: env : `(string * string) list` - List of key-value pairs for environment variables. Returns: `FunctionConfig`	Sets environment variables for the Lambda function. env : `(string * string) list` List of key-value pairs for environment variables. Returns: `FunctionConfig`
`environmentEncryption key` Full Usage: `environmentEncryption key` Parameters: key : `IKey` - KMS key for environment encryption. Returns: `FunctionConfig`	Sets a KMS key to encrypt environment variables. key : `IKey` KMS key for environment encryption. Returns: `FunctionConfig`
`ephemeralStorageSize sizeInMB` Full Usage: `ephemeralStorageSize sizeInMB` Parameters: sizeInMB : `int` - Storage size in megabytes (512-10240). Returns: `FunctionConfig`	Sets the ephemeral storage size for the Lambda function in MB. Default: 512 MB (free tier). Valid range: 512-10240 MB. Cost optimization: Only increase if needed for /tmp storage. sizeInMB : `int` Storage size in megabytes (512-10240). Returns: `FunctionConfig`
`event eventSource` Full Usage: `event eventSource` Parameters: eventSource : `IEventSource` - Event source. Returns: `FunctionConfig`	Adds a single event source to the function. eventSource : `IEventSource` Event source. Returns: `FunctionConfig`
`events eventSource` Full Usage: `events eventSource` Parameters: eventSource : `IEventSource list` - List of event sources. Returns: `FunctionConfig`	Adds a list of event sources to the function. eventSource : `IEventSource list` List of event sources. Returns: `FunctionConfig`