CreateFunctionRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.lambda.model.CreateFunctionRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable
```
public class CreateFunctionRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable
```
Container for the parameters to the CreateFunction operation.
Creates a new Lambda function. The function metadata is created from the request parameters, and the code for the function is provided by a .zip file in the request body. If the function name already exists, the operation will fail. Note that the function name is case-sensitive.

If you are using versioning, you can also publish a version of the Lambda function you are creating using the Publish parameter. For more information about versioning, see AWS Lambda Function Versioning and Aliases .

This operation requires permission for the lambda:CreateFunction action.

See Also:
AWSLambda.createFunction(CreateFunctionRequest), Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

CreateFunctionRequest()

Constructors
Constructor and Description
`CreateFunctionRequest()`

Method Summary

Methods
Modifier and Type	Method and Description
`CreateFunctionRequest`	`clone()` Creates a shallow clone of this request.
`boolean`	`equals(Object obj)`
`FunctionCode`	`getCode()` The code for the Lambda function.
`String`	`getDescription()` A short, user-defined function description.
`String`	`getFunctionName()` The name you want to assign to the function you are uploading.
`String`	`getHandler()` The function within your code that Lambda calls to begin execution.
`Integer`	`getMemorySize()` The amount of memory, in MB, your Lambda function is given.
`Boolean`	`getPublish()` This boolean parameter can be used to request AWS Lambda to create the Lambda function and publish a version as an atomic operation.
`String`	`getRole()` 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.
`String`	`getRuntime()` The runtime environment for the Lambda function you are uploading.
`Integer`	`getTimeout()` The function execution time at which Lambda should terminate the function.
`VpcConfig`	`getVpcConfig()` If your Lambda function accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs.
`int`	`hashCode()`
`Boolean`	`isPublish()` This boolean parameter can be used to request AWS Lambda to create the Lambda function and publish a version as an atomic operation.
`void`	`setCode(FunctionCode code)` The code for the Lambda function.
`void`	`setDescription(String description)` A short, user-defined function description.
`void`	`setFunctionName(String functionName)` The name you want to assign to the function you are uploading.
`void`	`setHandler(String handler)` The function within your code that Lambda calls to begin execution.
`void`	`setMemorySize(Integer memorySize)` The amount of memory, in MB, your Lambda function is given.
`void`	`setPublish(Boolean publish)` This boolean parameter can be used to request AWS Lambda to create the Lambda function and publish a version as an atomic operation.
`void`	`setRole(String 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.
`void`	`setRuntime(Runtime runtime)` The runtime environment for the Lambda function you are uploading.
`void`	`setRuntime(String runtime)` The runtime environment for the Lambda function you are uploading.
`void`	`setTimeout(Integer timeout)` The function execution time at which Lambda should terminate the function.
`void`	`setVpcConfig(VpcConfig vpcConfig)` If your Lambda function accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`CreateFunctionRequest`	`withCode(FunctionCode code)` The code for the Lambda function.
`CreateFunctionRequest`	`withDescription(String description)` A short, user-defined function description.
`CreateFunctionRequest`	`withFunctionName(String functionName)` The name you want to assign to the function you are uploading.
`CreateFunctionRequest`	`withHandler(String handler)` The function within your code that Lambda calls to begin execution.
`CreateFunctionRequest`	`withMemorySize(Integer memorySize)` The amount of memory, in MB, your Lambda function is given.
`CreateFunctionRequest`	`withPublish(Boolean publish)` This boolean parameter can be used to request AWS Lambda to create the Lambda function and publish a version as an atomic operation.
`CreateFunctionRequest`	`withRole(String 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.
`CreateFunctionRequest`	`withRuntime(Runtime runtime)` The runtime environment for the Lambda function you are uploading.
`CreateFunctionRequest`	`withRuntime(String runtime)` The runtime environment for the Lambda function you are uploading.
`CreateFunctionRequest`	`withTimeout(Integer timeout)` The function execution time at which Lambda should terminate the function.
`CreateFunctionRequest`	`withVpcConfig(VpcConfig vpcConfig)` If your Lambda function accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreateFunctionRequest
```
public CreateFunctionRequest()
```
- Method Detail
  - getFunctionName
```
public String getFunctionName()
```
    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 APIs, such as Invoke.
    Constraints:
    Length: 1 - 140
    Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?
    
    Returns:
    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 APIs, such as Invoke.
  - setFunctionName
```
public void setFunctionName(String 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 APIs, such as Invoke.
    Constraints:
    Length: 1 - 140
    Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?
    
    Parameters:
    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 APIs, such as Invoke.
  - withFunctionName
```
public CreateFunctionRequest withFunctionName(String 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 APIs, such as Invoke.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 140
    Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?
    
    Parameters:
    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 APIs, such as Invoke.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getRuntime
```
public String getRuntime()
```
    The runtime environment for the Lambda function you are uploading.
    Constraints:
    Allowed Values: nodejs, nodejs4.3, java8, python2.7
    
    Returns:
    The runtime environment for the Lambda function you are uploading.
    See Also:
    Runtime
  - setRuntime
```
public void setRuntime(String runtime)
```
    The runtime environment for the Lambda function you are uploading.
    Constraints:
    Allowed Values: nodejs, nodejs4.3, java8, python2.7
    
    Parameters:
    runtime - The runtime environment for the Lambda function you are uploading.
    See Also:
    Runtime
  - withRuntime
```
public CreateFunctionRequest withRuntime(String runtime)
```
    The runtime environment for the Lambda function you are uploading.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: nodejs, nodejs4.3, java8, python2.7
    
    Parameters:
    runtime - The runtime environment for the Lambda function you are uploading.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
    See Also:
    Runtime
  - setRuntime
```
public void setRuntime(Runtime runtime)
```
    The runtime environment for the Lambda function you are uploading.
    Constraints:
    Allowed Values: nodejs, nodejs4.3, java8, python2.7
    
    Parameters:
    runtime - The runtime environment for the Lambda function you are uploading.
    See Also:
    Runtime
  - withRuntime
```
public CreateFunctionRequest withRuntime(Runtime runtime)
```
    The runtime environment for the Lambda function you are uploading.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: nodejs, nodejs4.3, java8, python2.7
    
    Parameters:
    runtime - The runtime environment for the Lambda function you are uploading.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
    See Also:
    Runtime
  - getRole
```
public String getRole()
```
    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.
    Constraints:
    Pattern: arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+
    
    Returns:
    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.
  - setRole
```
public void setRole(String 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.
    Constraints:
    Pattern: arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+
    
    Parameters:
    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.
  - withRole
```
public CreateFunctionRequest withRole(String 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.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Pattern: arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+
    
    Parameters:
    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.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getHandler
```
public String getHandler()
```
    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).
    Constraints:
    Length: 0 - 128
    Pattern: [^\s]+
    
    Returns:
    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).
  - setHandler
```
public void setHandler(String 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).
    Constraints:
    Length: 0 - 128
    Pattern: [^\s]+
    
    Parameters:
    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).
  - withHandler
```
public CreateFunctionRequest withHandler(String 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).
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 0 - 128
    Pattern: [^\s]+
    
    Parameters:
    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).
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getCode
```
public FunctionCode getCode()
```
    The code for the Lambda function.
    
    Returns:
    The code for the Lambda function.
  - setCode
```
public void setCode(FunctionCode code)
```
    The code for the Lambda function.
    
    Parameters:
    code - The code for the Lambda function.
  - withCode
```
public CreateFunctionRequest withCode(FunctionCode code)
```
    The code for the Lambda function.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    code - The code for the Lambda function.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getDescription
```
public String getDescription()
```
    A short, user-defined function description. Lambda does not use this value. Assign a meaningful description as you see fit.
    Constraints:
    Length: 0 - 256
    
    Returns:
    A short, user-defined function description. Lambda does not use this value. Assign a meaningful description as you see fit.
  - setDescription
```
public void setDescription(String description)
```
    A short, user-defined function description. Lambda does not use this value. Assign a meaningful description as you see fit.
    Constraints:
    Length: 0 - 256
    
    Parameters:
    description - A short, user-defined function description. Lambda does not use this value. Assign a meaningful description as you see fit.
  - withDescription
```
public CreateFunctionRequest withDescription(String description)
```
    A short, user-defined function description. Lambda does not use this value. Assign a meaningful description as you see fit.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 0 - 256
    
    Parameters:
    description - A short, user-defined function description. Lambda does not use this value. Assign a meaningful description as you see fit.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getTimeout
```
public Integer getTimeout()
```
    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.
    Constraints:
    Range: 1 -
    
    Returns:
    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.
  - setTimeout
```
public void setTimeout(Integer 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.
    Constraints:
    Range: 1 -
    
    Parameters:
    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.
  - withTimeout
```
public CreateFunctionRequest withTimeout(Integer 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.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 1 -
    
    Parameters:
    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.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getMemorySize
```
public Integer getMemorySize()
```
    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.
    Constraints:
    Range: 128 - 1536
    
    Returns:
    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.
  - setMemorySize
```
public void setMemorySize(Integer 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.
    Constraints:
    Range: 128 - 1536
    
    Parameters:
    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.
  - withMemorySize
```
public CreateFunctionRequest withMemorySize(Integer 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.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 128 - 1536
    
    Parameters:
    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.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - isPublish
```
public Boolean isPublish()
```
    This boolean parameter can be used to request AWS Lambda to create the Lambda function and publish a version as an atomic operation.
    
    Returns:
    This boolean parameter can be used to request AWS Lambda to create the Lambda function and publish a version as an atomic operation.
  - setPublish
```
public void setPublish(Boolean publish)
```
    This boolean parameter can be used to request AWS Lambda to create the Lambda function and publish a version as an atomic operation.
    
    Parameters:
    publish - This boolean parameter can be used to request AWS Lambda to create the Lambda function and publish a version as an atomic operation.
  - withPublish
```
public CreateFunctionRequest withPublish(Boolean publish)
```
    This boolean parameter can be used to request AWS Lambda to create the Lambda function and publish a version as an atomic operation.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    publish - This boolean parameter can be used to request AWS Lambda to create the Lambda function and publish a version as an atomic operation.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getPublish
```
public Boolean getPublish()
```
    This boolean parameter can be used to request AWS Lambda to create the Lambda function and publish a version as an atomic operation.
    
    Returns:
    This boolean parameter can be used to request AWS Lambda to create the Lambda function and publish a version as an atomic operation.
  - getVpcConfig
```
public VpcConfig getVpcConfig()
```
    If your Lambda function accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and one subnet ID.
    
    Returns:
    If your Lambda function accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and one subnet ID.
  - setVpcConfig
```
public void setVpcConfig(VpcConfig vpcConfig)
```
    If your Lambda function accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and one subnet ID.
    
    Parameters:
    vpcConfig - If your Lambda function accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and one subnet ID.
  - withVpcConfig
```
public CreateFunctionRequest withVpcConfig(VpcConfig vpcConfig)
```
    If your Lambda function accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and one subnet ID.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    vpcConfig - If your Lambda function accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and one subnet ID.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    A string representation of this object.
    See Also:
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - clone
```
public CreateFunctionRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    Object.clone()

Did this page help you?

Class CreateFunctionRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateFunctionRequest

Method Detail

getFunctionName

setFunctionName

withFunctionName

getRuntime

setRuntime

withRuntime

setRuntime

withRuntime

getRole

setRole

withRole

getHandler

setHandler

withHandler

getCode

setCode

withCode

getDescription

setDescription

withDescription

getTimeout

setTimeout

withTimeout

getMemorySize

setMemorySize

withMemorySize

isPublish

setPublish

withPublish

getPublish

getVpcConfig

setVpcConfig

withVpcConfig

toString

hashCode

equals

clone