Class FunctionArgs

Inheritance

System.Object

InputArgs

ResourceArgs

FunctionArgs

Inherited Members

ResourceArgs.Empty

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.Lambda

Assembly: Pulumi.Aws.dll

Syntax

public sealed class FunctionArgs : ResourceArgs

Constructors

FunctionArgs()

Declaration

public FunctionArgs()

Properties

Code

The path to the function's deployment package within the local filesystem. If defined, The s3_-prefixed options cannot be used.

Declaration

public Input<Archive> Code { get; set; }

Property Value

Type	Description
Input<Archive>

DeadLetterConfig

Nested block to configure the function's dead letter queue. See details below.

Declaration

public Input<FunctionDeadLetterConfigArgs> DeadLetterConfig { get; set; }

Property Value

Type	Description
Input<FunctionDeadLetterConfigArgs>

Description

Description of what your Lambda Function does.

Declaration

public Input<string> Description { get; set; }

Property Value

Type	Description
Input<System.String>

Environment

The Lambda environment's configuration settings. Fields documented below.

Declaration

public Input<FunctionEnvironmentArgs> Environment { get; set; }

Property Value

Type	Description
Input<FunctionEnvironmentArgs>

Handler

The function entrypoint in your code.

Declaration

public Input<string> Handler { get; set; }

Property Value

Type	Description
Input<System.String>

KmsKeyArn

Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key that is used to encrypt environment variables. If this configuration is not provided when environment variables are in use, AWS Lambda uses a default service key. If this configuration is provided when environment variables are not in use, the AWS Lambda API does not save this configuration and this provider will show a perpetual difference of adding the key. To fix the perpetual difference, remove this configuration.

Declaration

public Input<string> KmsKeyArn { get; set; }

Property Value

Type	Description
Input<System.String>

Layers

List of Lambda Layer Version ARNs (maximum of 5) to attach to your Lambda Function. See Lambda Layers

Declaration

public InputList<string> Layers { get; set; }

Property Value

Type	Description
InputList<System.String>

MemorySize

Amount of memory in MB your Lambda Function can use at runtime. Defaults to 128. See Limits

Declaration

public Input<int> MemorySize { get; set; }

Property Value

Type	Description
Input<System.Int32>

Name

A unique name for your Lambda Function.

Declaration

public Input<string> Name { get; set; }

Property Value

Type	Description
Input<System.String>

Publish

Whether to publish creation/change as new Lambda Function Version. Defaults to false.

Declaration

public Input<bool> Publish { get; set; }

Property Value

Type	Description
Input<System.Boolean>

ReservedConcurrentExecutions

The amount of reserved concurrent executions for this lambda function. A value of 0 disables lambda from being triggered and -1 removes any concurrency limitations. Defaults to Unreserved Concurrency Limits -1. See Managing Concurrency

Declaration

public Input<int> ReservedConcurrentExecutions { get; set; }

Property Value

Type	Description
Input<System.Int32>

Role

IAM role attached to the Lambda Function. This governs both who / what can invoke your Lambda Function, as well as what resources our Lambda Function has access to. See Lambda Permission Model for more details.

Declaration

public Input<string> Role { get; set; }

Property Value

Type	Description
Input<System.String>

Runtime

See Runtimes for valid values.

Declaration

public Input<string> Runtime { get; set; }

Property Value

Type	Description
Input<System.String>

S3Bucket

The S3 bucket location containing the function's deployment package. Conflicts with filename. This bucket must reside in the same AWS region where you are creating the Lambda function.

Declaration

public Input<string> S3Bucket { get; set; }

Property Value

Type	Description
Input<System.String>

S3Key

The S3 key of an object containing the function's deployment package. Conflicts with filename.

Declaration

public Input<string> S3Key { get; set; }

Property Value

Type	Description
Input<System.String>

S3ObjectVersion

The object version containing the function's deployment package. Conflicts with filename.

Declaration

public Input<string> S3ObjectVersion { get; set; }

Property Value

Type	Description
Input<System.String>

SourceCodeHash

Used to trigger updates. Must be set to a base64-encoded SHA256 hash of the package file specified with either filename or s3_key. The usual way to set this is filebase64sha256("file.zip") (this provider 0.11.12 and later) or base64sha256(file("file.zip")) (this provider 0.11.11 and earlier), where "file.zip" is the local filename of the lambda function source archive.

Declaration

public Input<string> SourceCodeHash { get; set; }

Property Value

Type	Description
Input<System.String>

Tags

A mapping of tags to assign to the object.

Declaration

public InputMap<object> Tags { get; set; }

Property Value

Type	Description
InputMap<System.Object>

Timeout

The amount of time your Lambda Function has to run in seconds. Defaults to 3. See Limits

Declaration

public Input<int> Timeout { get; set; }

Property Value

Type	Description
Input<System.Int32>

TracingConfig

Declaration

public Input<FunctionTracingConfigArgs> TracingConfig { get; set; }

Property Value

Type	Description
Input<FunctionTracingConfigArgs>

VpcConfig

Provide this to allow your function to access your VPC. Fields documented below. See Lambda in VPC

Declaration

public Input<FunctionVpcConfigArgs> VpcConfig { get; set; }

Property Value

Type	Description
Input<FunctionVpcConfigArgs>