Container for the parameters to the CreateFunction operation. Creates a Lambda function. To create a function, you need a deployment package and an execution role. The deployment package is a .zip file archive or container image that contains your function code. The execution role grants the function permission to use Amazon Web Services, such as Amazon CloudWatch Logs for log streaming and X-Ray for request tracing.
If the deployment package is a container
image, then you set the package type to Image. For a container image, the
code property must include the URI of a container image in the Amazon ECR registry.
You do not need to specify the handler and runtime properties.
If the deployment package is a .zip
file archive, then you set the package type to Zip. For a .zip file archive,
the code property specifies the location of the .zip file. You must also specify the
handler and runtime properties. The code in the deployment package must be compatible
with the target instruction set architecture of the function (x86-64 or arm64).
If you do not specify the architecture, then the default value is x86-64.
When you create a function, Lambda provisions an instance of the function and its
supporting resources. If your function connects to a VPC, this process can take a
minute or so. During this time, you can't invoke or modify the function. The State,
StateReason, and StateReasonCode fields in the response from GetFunctionConfiguration
indicate when the function is ready to invoke. For more information, see Lambda
function states.
A function has an unpublished version, and can have published versions and aliases.
The unpublished version changes when you update your function's code and configuration.
A published version is a snapshot of your function code and configuration that can't
be changed. An alias is a named resource that maps to a version, and can be changed
to map to a different version. Use the Publish parameter to create version
1 of your function from its initial configuration.
The other parameters let you configure version-specific and function-level settings. You can modify version-specific settings later with UpdateFunctionConfiguration. Function-level settings apply to both the unpublished and published versions of the function, and include tags (TagResource) and per-function concurrency limits (PutFunctionConcurrency).
You can use code signing if your deployment package is a .zip file archive. To enable code signing for this function, specify the ARN of a code-signing configuration. When a user attempts to deploy a code package with UpdateFunctionCode, Lambda checks that the code package has a valid signature from a trusted publisher. The code-signing configuration includes set of signing profiles, which define the trusted publishers for this function.
If another Amazon Web Services account or an Amazon Web Service invokes your function, use AddPermission to grant permission by creating a resource-based Identity and Access Management (IAM) policy. You can grant permissions at the function level, on a version, or on an alias.
To invoke your function directly, use Invoke. To invoke your function in response to events in other Amazon Web Services, create an event source mapping (CreateEventSourceMapping), or configure a function trigger in the other service. For more information, see Invoking Lambda functions.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.Lambda.AmazonLambdaRequest
Amazon.Lambda.Model.CreateFunctionRequest
Namespace: Amazon.Lambda.Model
Assembly: AWSSDK.Lambda.dll
Version: 3.x.y.z
Syntax
public class CreateFunctionRequest : AmazonLambdaRequest IAmazonWebServiceRequest
The CreateFunctionRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
CreateFunctionRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
Architectures | System.Collections.Generic.List<System.String> |
Gets and sets the property Architectures.
The instruction set architecture that the function supports. Enter a string array
with one of the valid values (arm64 or x86_64). The default value is |
|
|
Code | Amazon.Lambda.Model.FunctionCode |
Gets and sets the property Code. The code for the function. |
|
|
CodeSigningConfigArn | System.String |
Gets and sets the property CodeSigningConfigArn. To enable code signing for this function, specify the ARN of a code-signing configuration. A code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function. |
|
|
DeadLetterConfig | Amazon.Lambda.Model.DeadLetterConfig |
Gets and sets the property DeadLetterConfig. A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead-letter queues. |
|
|
Description | System.String |
Gets and sets the property Description. A description of the function. |
|
|
Environment | Amazon.Lambda.Model.Environment |
Gets and sets the property Environment. Environment variables that are accessible from function code during execution. |
|
|
EphemeralStorage | Amazon.Lambda.Model.EphemeralStorage |
Gets and sets the property EphemeralStorage.
The size of the function's |
|
|
FileSystemConfigs | System.Collections.Generic.List<Amazon.Lambda.Model.FileSystemConfig> |
Gets and sets the property FileSystemConfigs. Connection settings for an Amazon EFS file system. |
|
|
FunctionName | System.String |
Gets and sets the property FunctionName. The name or ARN of the Lambda function. Name formats
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length. |
|
|
Handler | System.String |
Gets and sets the property Handler. The name of the method within your code that Lambda calls to run your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Lambda programming model. |
|
|
ImageConfig | Amazon.Lambda.Model.ImageConfig |
Gets and sets the property ImageConfig. Container image configuration values that override the values in the container image Dockerfile. |
|
|
KMSKeyArn | System.String |
Gets and sets the property KMSKeyArn. The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt your function's environment variables. When Lambda SnapStart is activated, Lambda also uses this key is to encrypt your function's snapshot. If you deploy your function using a container image, Lambda also uses this key to encrypt your function when it's deployed. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). If you don't provide a customer managed key, Lambda uses a default service key. |
|
|
Layers | System.Collections.Generic.List<System.String> |
Gets and sets the property Layers. A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version. |
|
|
LoggingConfig | Amazon.Lambda.Model.LoggingConfig |
Gets and sets the property LoggingConfig. The function's Amazon CloudWatch Logs configuration settings. |
|
|
MemorySize | System.Int32 |
Gets and sets the property MemorySize. The amount of memory available to the function at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB. |
|
|
PackageType | Amazon.Lambda.PackageType |
Gets and sets the property PackageType.
The type of deployment package. Set to |
|
|
Publish | System.Boolean |
Gets and sets the property Publish. Set to true to publish the first version of the function during creation. |
|
|
Role | System.String |
Gets and sets the property Role. The Amazon Resource Name (ARN) of the function's execution role. |
|
|
Runtime | Amazon.Lambda.Runtime |
Gets and sets the property Runtime. The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive. The following list includes deprecated runtimes. For more information, see Runtime deprecation policy. |
|
|
SnapStart | Amazon.Lambda.Model.SnapStart |
Gets and sets the property SnapStart. The function's SnapStart setting. |
|
|
StreamTransferProgress | System.EventHandler<Amazon.Runtime.StreamTransferProgressArgs> |
Attach a callback that will be called as data is being sent to the AWS Service. |
|
|
Tags | System.Collections.Generic.Dictionary<System.String, System.String> |
Gets and sets the property Tags. A list of tags to apply to the function. |
|
|
Timeout | System.Int32 |
Gets and sets the property Timeout. The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see Lambda execution environment. |
|
|
TracingConfig | Amazon.Lambda.Model.TracingConfig |
Gets and sets the property TracingConfig.
Set |
|
|
VpcConfig | Amazon.Lambda.Model.VpcConfig |
Gets and sets the property VpcConfig. For network connectivity to Amazon Web Services resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can access resources and the internet only through that VPC. For more information, see Configuring a Lambda function to access resources in a VPC. |
Examples
The following example creates a function with a deployment package in Amazon S3 and enables X-Ray tracing and environment variable encryption.
To create a function
var response = client.CreateFunction(new CreateFunctionRequest
{
Code = new FunctionCode {
S3Bucket = "my-bucket-1xpuxmplzrlbh",
S3Key = "function.zip"
},
Description = "Process image objects from Amazon S3.",
Environment = new Environment { Variables = new Dictionary<string, string> {
{ "BUCKET", "my-bucket-1xpuxmplzrlbh" },
{ "PREFIX", "inbound" }
} },
FunctionName = "my-function",
Handler = "index.handler",
KMSKeyArn = "arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966",
MemorySize = 256,
Publish = true,
Role = "arn:aws:iam::123456789012:role/lambda-role",
Runtime = "nodejs12.x",
Tags = new Dictionary<string, string> {
{ "DEPARTMENT", "Assets" }
},
Timeout = 15,
TracingConfig = new TracingConfig { Mode = "Active" }
});
string codeSha256 = response.CodeSha256;
long codeSize = response.CodeSize;
string description = response.Description;
EnvironmentResponse environment = response.Environment;
string functionArn = response.FunctionArn;
string functionName = response.FunctionName;
string handler = response.Handler;
string kmsKeyArn = response.KMSKeyArn;
string lastModified = response.LastModified;
string lastUpdateStatus = response.LastUpdateStatus;
int memorySize = response.MemorySize;
string revisionId = response.RevisionId;
string role = response.Role;
string runtime = response.Runtime;
string state = response.State;
int timeout = response.Timeout;
TracingConfigResponse tracingConfig = response.TracingConfig;
string version = response.Version;
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5