CreateFunctionSettings Class

Summary

The settings to use with downlad requests to Amazon Lambda
Assembly
Cake.AWS.Lambda.dll
Namespace
Cake.AWS.Lambda
Base Types
graph BT Type-->Base0["CodeSettings"] click Base0 "/api/Cake.AWS.Lambda/CodeSettings" Base0-->Base1["ClientSettings"] click Base1 "/api/Cake.AWS.Lambda/ClientSettings" Base1-->Base2["Object"] Type["CreateFunctionSettings"] class Type type-node

Syntax

public class CreateFunctionSettings : CodeSettings

Constructors

Name Summary
CreateFunctionSettings() Initializes a new instance of the UpdateFunctionCodeSettings class.

Properties

Name Value Summary
AccessKey string
The AWS Access Key ID
Inherited from ClientSettings
DeadLetterConfig string
Gets and sets the property DeadLetterConfig. The parent object that contains the target ARN (Amazon Resource Name) of an Amazon SQS queue or Amazon SNS topic.
Description string
Gets and sets the property Description. A short, user-defined function description. Lambda does not use this value. Assign a meaningful description as you see fit.
Environment Dictionary<string, string>
Gets and sets the property Environment.
FunctionName string
Gets and sets the property FunctionName. The name you want to assign to the function you are uploading. The function names appear in the console and are returned in the ListFunctions API. Function names are used to specify functions to other AWS Lambda API operations, such as Invoke. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.
Handler string
Gets and sets the property Handler. The function within your code that Lambda calls to begin execution. For Node.js, it is the module-name.export value in your function. For Java, it can be package.class-name::handler or package.class-name. For more information, see Lambda Function Handler (Java).
KMSKeyArn string
Gets and sets the property KMSKeyArn. The Amazon Resource Name (ARN) of the KMS key used to encrypt your function's environment variables. If not provided, AWS Lambda will use a default service key.
MemorySize int
Gets and sets the property MemorySize. The amount of memory, in MB, your Lambda function is given. Lambda uses this memory size to infer the amount of CPU and memory allocated to your function. Your function use-case determines your CPU and memory requirements. For example, a database operation might need less memory compared to an image processing function. The default value is 128 MB. The value must be a multiple of 64 MB.
Publish bool
Gets and sets the property Publish. This boolean parameter can be used to request AWS Lambda to create the Lambda function and publish a version as an atomic operation.
Region RegionEndpoint
The endpoints available to AWS clients.
Inherited from ClientSettings
Role string
Gets and sets the property Role. The Amazon Resource Name (ARN) of the IAM role that Lambda assumes when it executes your function to access any other Amazon Web Services (AWS) resources. For more information, see AWS Lambda: How it Works.
Runtime string
Gets and sets the property Runtime.The runtime environment for the Lambda function you are uploading. To use the Python runtime v3.6, set the value to "python3.6". To use the Python runtime v2.7, set the value to "python2.7". To use the Node.js runtime v6.10, set the value to "nodejs6.10". To use the Node.js runtime v4.3, set the value to "nodejs4.3". Node v0.10.42 is currently marked as deprecated. You must migrate existing functions to the newer Node.js runtime versions available on AWS Lambda (nodejs4.3 or nodejs6.10) as soon as possible. You can request a one-time extension until June 30, 2017 by going to the Lambda console and following the instructions provided. Failure to do so will result in an invalid parmaeter error being returned. Note that you will have to follow this procedure for each region that contains functions written in the Node v0.10.42 runtime.
S3Bucket string
The name of the Amazon S3 bucket where the bundled artifacts are stored.
Inherited from CodeSettings
S3Key string
The name of the Amazon S3 object that represents the bundled artifacts you want to upload.
Inherited from CodeSettings
S3Version string
A specific version of the Amazon S3 object that represents the bundled artifacts you want to upload.
Inherited from CodeSettings
SecretKey string
The AWS Secret Access Key.
Inherited from ClientSettings
SessionToken string
The AWS Session Token, if using temporary credentials.
Inherited from ClientSettings
Tags Dictionary<string, string>
Gets and sets the property Tags. The list of tags (key-value pairs) assigned to the new function.
Timeout int
Gets and sets the property Timeout. The function execution time at which Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.
TracingConfig string
Gets and sets the property TracingConfig. The parent object that contains your function's tracing settings.
VpcSecurityGroupIds List<string>
Gets and sets the property SecurityGroupIds. A list of one or more security groups IDs in your VPC.
VpcSubnetIds List<string>
Gets and sets the property SubnetIds. A list of one or more subnet IDs in your VPC.
WorkingDirectory DirectoryPath
Gets or sets the working directory for the process to be started.
Inherited from CodeSettings
ZipFile MemoryStream
The contents of your zip file containing your deployment package.
Inherited from CodeSettings
ZipPath FilePath
The path to your zip file containing your deployment package.
Inherited from CodeSettings

Extension Methods

Name Value Summary
Dump<CreateFunctionSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
Initialize<CreateFunctionSettings>(ICakeEnvironment) T
Helper method to get the AWS Credentials from environment variables
Requires the Cake.AWS.Lambda addin
IsIn<CreateFunctionSettings>(CreateFunctionSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<CreateFunctionSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<CreateFunctionSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
SetAccessKey(string) ClientSettings
Specifies the AWS Access Key to use as credentials.
Requires the Cake.AWS.Lambda addin
SetRegion(RegionEndpoint) ClientSettings
Specifies the endpoints available to AWS clients.
Requires the Cake.AWS.Lambda addin
SetRegion(string) ClientSettings
Specifies the endpoints available to AWS clients.
Requires the Cake.AWS.Lambda addin
SetSecretKey(string) ClientSettings
Specifies the AWS Secret Key to use as credentials.
Requires the Cake.AWS.Lambda addin
SetSessionToken(string) ClientSettings
Specifies the AWS Session Token to use as credentials.
Requires the Cake.AWS.Lambda addin
ThrowIfNull<CreateFunctionSettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<CreateFunctionSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin