FunctionProps (software.amazon.awscdk:lambda 0.14.1 API)

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

SingletonFunctionProps

All Known Implementing Classes:

FunctionProps.Jsii$Proxy, SingletonFunctionProps.Jsii$Proxy
```
@Generated(value="jsii-pacmak/0.7.8 (build 100f5ad)",
           date="2018-10-26T17:58:07.464Z")
public interface FunctionProps
extends software.amazon.jsii.JsiiSerializable
```

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`FunctionProps.Builder` A builder for `FunctionProps`
`static class`	`FunctionProps.Jsii$Proxy` A proxy class which represents a concrete javascript instance of this type.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static FunctionProps.Builder`	`builder()`
`Boolean`	`getAllowAllOutbound()` Whether to allow the Lambda to send all network traffic If set to false, you must individually add traffic rules to allow the Lambda to connect to network targets.
`Code`	`getCode()` The source code of your Lambda function.
`software.amazon.awscdk.services.sqs.QueueRef`	`getDeadLetterQueue()` The SQS queue to use if DLQ is enabled.
`Boolean`	`getDeadLetterQueueEnabled()` Enabled DLQ.
`String`	`getDescription()` A description of the function.
`Map<String,Object>`	`getEnvironment()` Key-value pairs that Lambda caches and makes available for your Lambda functions.
`String`	`getFunctionName()` A name for the function.
`String`	`getHandler()` The name of the function (within your source code) that Lambda calls to start running your code.
`List<software.amazon.awscdk.services.iam.PolicyStatement>`	`getInitialPolicy()` Initial policy statements to add to the created Lambda Role.
`Number`	`getMemorySize()` The amount of memory, in MB, that is allocated to your Lambda function.
`software.amazon.awscdk.services.iam.Role`	`getRole()` Lambda execution role.
`Runtime`	`getRuntime()` The runtime environment for the Lambda function that you are uploading.
`software.amazon.awscdk.services.ec2.SecurityGroupRef`	`getSecurityGroup()` What security group to associate with the Lambda's network interfaces.
`Number`	`getTimeout()` The function execution time (in seconds) after which Lambda terminates the function.
`Tracing`	`getTracing()` Enable AWS X-Ray Tracing for Lambda Function.
`software.amazon.awscdk.services.ec2.VpcNetworkRef`	`getVpc()` VPC network to place Lambda network interfaces Specify this if the Lambda function needs to access resources in a VPC.
`software.amazon.awscdk.services.ec2.VpcPlacementStrategy`	`getVpcPlacement()` Where to place the network interfaces within the VPC.
`void`	`setAllowAllOutbound(Boolean value)` Whether to allow the Lambda to send all network traffic If set to false, you must individually add traffic rules to allow the Lambda to connect to network targets.
`void`	`setCode(Code value)` The source code of your Lambda function.
`void`	`setDeadLetterQueue(software.amazon.awscdk.services.sqs.QueueRef value)` The SQS queue to use if DLQ is enabled.
`void`	`setDeadLetterQueueEnabled(Boolean value)` Enabled DLQ.
`void`	`setDescription(String value)` A description of the function.
`void`	`setEnvironment(Map<String,Object> value)` Key-value pairs that Lambda caches and makes available for your Lambda functions.
`void`	`setFunctionName(String value)` A name for the function.
`void`	`setHandler(String value)` The name of the function (within your source code) that Lambda calls to start running your code.
`void`	`setInitialPolicy(List<software.amazon.awscdk.services.iam.PolicyStatement> value)` Initial policy statements to add to the created Lambda Role.
`void`	`setMemorySize(Number value)` The amount of memory, in MB, that is allocated to your Lambda function.
`void`	`setRole(software.amazon.awscdk.services.iam.Role value)` Lambda execution role.
`void`	`setRuntime(Runtime value)` The runtime environment for the Lambda function that you are uploading.
`void`	`setSecurityGroup(software.amazon.awscdk.services.ec2.SecurityGroupRef value)` What security group to associate with the Lambda's network interfaces.
`void`	`setTimeout(Number value)` The function execution time (in seconds) after which Lambda terminates the function.
`void`	`setTracing(Tracing value)` Enable AWS X-Ray Tracing for Lambda Function.
`void`	`setVpc(software.amazon.awscdk.services.ec2.VpcNetworkRef value)` VPC network to place Lambda network interfaces Specify this if the Lambda function needs to access resources in a VPC.
`void`	`setVpcPlacement(software.amazon.awscdk.services.ec2.VpcPlacementStrategy value)` Where to place the network interfaces within the VPC.

- Method Detail
  - getCode
```
Code getCode()
```
    The source code of your Lambda function. You can point to a file in an Amazon Simple Storage Service (Amazon S3) bucket or specify your source code as inline text.
  - setCode
```
void setCode(Code value)
```
    The source code of your Lambda function. You can point to a file in an Amazon Simple Storage Service (Amazon S3) bucket or specify your source code as inline text.
  - getHandler
```
String getHandler()
```
    The name of the function (within your source code) that Lambda calls to start running your code. For more information, see the Handler property in the AWS Lambda Developer Guide. 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.
  - setHandler
```
void setHandler(String value)
```
    The name of the function (within your source code) that Lambda calls to start running your code. For more information, see the Handler property in the AWS Lambda Developer Guide. 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.
  - getRuntime
```
Runtime getRuntime()
```
    The runtime environment for the Lambda function that you are uploading. For valid values, see the Runtime property in the AWS Lambda Developer Guide.
  - setRuntime
```
void setRuntime(Runtime value)
```
    The runtime environment for the Lambda function that you are uploading. For valid values, see the Runtime property in the AWS Lambda Developer Guide.
  - getAllowAllOutbound
```
Boolean getAllowAllOutbound()
```
    Whether to allow the Lambda to send all network traffic If set to false, you must individually add traffic rules to allow the Lambda to connect to network targets.
  - setAllowAllOutbound
```
void setAllowAllOutbound(Boolean value)
```
    Whether to allow the Lambda to send all network traffic If set to false, you must individually add traffic rules to allow the Lambda to connect to network targets.
  - getDeadLetterQueue
```
software.amazon.awscdk.services.sqs.QueueRef getDeadLetterQueue()
```
    The SQS queue to use if DLQ is enabled.
  - setDeadLetterQueue
```
void setDeadLetterQueue(software.amazon.awscdk.services.sqs.QueueRef value)
```
    The SQS queue to use if DLQ is enabled.
  - getDeadLetterQueueEnabled
```
Boolean getDeadLetterQueueEnabled()
```
    Enabled DLQ. If `deadLetterQueue` is undefined, an SQS queue with default options will be defined for your Function.
  - setDeadLetterQueueEnabled
```
void setDeadLetterQueueEnabled(Boolean value)
```
    Enabled DLQ. If `deadLetterQueue` is undefined, an SQS queue with default options will be defined for your Function.
  - getDescription
```
String getDescription()
```
    A description of the function.
  - setDescription
```
void setDescription(String value)
```
    A description of the function.
  - getEnvironment
```
Map<String,Object> getEnvironment()
```
    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.
  - setEnvironment
```
void setEnvironment(Map<String,Object> value)
```
    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.
  - getFunctionName
```
String getFunctionName()
```
    A name for the function. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the function's name. For more information, see Name Type.
  - setFunctionName
```
void setFunctionName(String value)
```
    A name for the function. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the function's name. For more information, see Name Type.
  - getInitialPolicy
```
List<software.amazon.awscdk.services.iam.PolicyStatement> getInitialPolicy()
```
    Initial policy statements to add to the created Lambda Role. You can call `addToRolePolicy` to the created lambda to add statements post creation.
  - setInitialPolicy
```
void setInitialPolicy(List<software.amazon.awscdk.services.iam.PolicyStatement> value)
```
    Initial policy statements to add to the created Lambda Role. You can call `addToRolePolicy` to the created lambda to add statements post creation.
  - getMemorySize
```
Number getMemorySize()
```
    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.
  - setMemorySize
```
void setMemorySize(Number value)
```
    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.
  - getRole
```
software.amazon.awscdk.services.iam.Role getRole()
```
    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.
  - setRole
```
void setRole(software.amazon.awscdk.services.iam.Role value)
```
    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.
  - getSecurityGroup
```
software.amazon.awscdk.services.ec2.SecurityGroupRef getSecurityGroup()
```
    What security group to associate with the Lambda's network interfaces. Only used if 'vpc' is supplied.
  - setSecurityGroup
```
void setSecurityGroup(software.amazon.awscdk.services.ec2.SecurityGroupRef value)
```
    What security group to associate with the Lambda's network interfaces. Only used if 'vpc' is supplied.
  - getTimeout
```
Number getTimeout()
```
    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.
  - setTimeout
```
void setTimeout(Number value)
```
    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.
  - getTracing
```
Tracing getTracing()
```
    Enable AWS X-Ray Tracing for Lambda Function.
  - setTracing
```
void setTracing(Tracing value)
```
    Enable AWS X-Ray Tracing for Lambda Function.
  - getVpc
```
software.amazon.awscdk.services.ec2.VpcNetworkRef getVpc()
```
    VPC network to place Lambda network interfaces Specify this if the Lambda function needs to access resources in a VPC.
  - setVpc
```
void setVpc(software.amazon.awscdk.services.ec2.VpcNetworkRef value)
```
    VPC network to place Lambda network interfaces Specify this if the Lambda function needs to access resources in a VPC.
  - getVpcPlacement
```
software.amazon.awscdk.services.ec2.VpcPlacementStrategy getVpcPlacement()
```
    Where to place the network interfaces within the VPC. Only used if 'vpc' is supplied. Note: internet access for Lambdas requires a NAT gateway, so picking Public subnets is not allowed.
  - setVpcPlacement
```
void setVpcPlacement(software.amazon.awscdk.services.ec2.VpcPlacementStrategy value)
```
    Where to place the network interfaces within the VPC. Only used if 'vpc' is supplied. Note: internet access for Lambdas requires a NAT gateway, so picking Public subnets is not allowed.
  - builder
```
static FunctionProps.Builder builder()
```
    Returns:
    
    a FunctionProps.Builder of FunctionProps

Interface FunctionProps

Nested Class Summary

Method Summary

Method Detail

getCode

setCode

getHandler

setHandler

getRuntime

setRuntime

getAllowAllOutbound

setAllowAllOutbound

getDeadLetterQueue

setDeadLetterQueue

getDeadLetterQueueEnabled

setDeadLetterQueueEnabled

getDescription

setDescription

getEnvironment

setEnvironment

getFunctionName

setFunctionName

getInitialPolicy

setInitialPolicy

getMemorySize

setMemorySize

getRole

setRole

getSecurityGroup

setSecurityGroup

getTimeout

setTimeout

getTracing

setTracing

getVpc

setVpc

getVpcPlacement

setVpcPlacement

builder