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

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

SingletonFunctionProps

All Known Implementing Classes:

FunctionProps.Jsii$Pojo, FunctionProps.Jsii$Proxy, SingletonFunctionProps.Jsii$Pojo, SingletonFunctionProps.Jsii$Proxy
```
public interface FunctionProps
extends software.amazon.jsii.JsiiSerializable
```

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`FunctionProps.Builder` A fluent step builder class for `FunctionProps`.
`static class`	`FunctionProps.Jsii$Pojo` A PoJo (plain-old-java-object) class that implements `FunctionProps`.
`static class`	`FunctionProps.Jsii$Proxy` A proxy class which for javascript object literal which adhere to this interface.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static FunctionProps.Builder`	`builder()`
`Code`	`getCode()` The source code of your Lambda function.
`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.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.
`Number`	`getTimeout()` The function execution time (in seconds) after which Lambda terminates the function.
`void`	`setCode(Code value)` The source code of your Lambda function.
`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.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`	`setTimeout(Number value)` The function execution time (in seconds) after which Lambda terminates the function.

- 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.
  - getDescription
```
String getDescription()
```
    A description of the function.
  - setDescription
```
void setDescription(String value)
```
    A description of the function.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - getInitialPolicy
```
List<software.amazon.awscdk.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.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.
  - 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.
  - builder
```
static FunctionProps.Builder builder()
```

Interface FunctionProps

Nested Class Summary

Method Summary

Method Detail

getCode

setCode

getDescription

setDescription

getHandler

setHandler

getTimeout

setTimeout

getEnvironment

setEnvironment

getRuntime

setRuntime

getFunctionName

setFunctionName

getMemorySize

setMemorySize

getInitialPolicy

setInitialPolicy

getRole

setRole

builder