com.amazonaws.services.lambda.model

Class UploadFunctionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.lambda.model.UploadFunctionRequest

All Implemented Interfaces:

Serializable

public class UploadFunctionRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the UploadFunction operation.

Creates a new Lambda function or updates an existing 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 existing Lambda function is updated with the new code and metadata.

This operation requires permission for the lambda:UploadFunction action.

See Also:

AWSLambda.uploadFunction(UploadFunctionRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UploadFunctionRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getDescription() A short, user-defined function description.
String	getFunctionName() The name you want to assign to the function you are uploading.
InputStream	getFunctionZip() A .zip file containing your packaged source code.
String	getHandler() The function that Lambda calls to begin execution.
Integer	getMemorySize() The amount of memory, in MB, your Lambda function is given.
String	getMode() How the Lambda function will be invoked.
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.
int	hashCode()
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	setFunctionZip(InputStream functionZip) A .zip file containing your packaged source code.
void	setHandler(String handler) The function that Lambda calls to begin execution.
void	setMemorySize(Integer memorySize) The amount of memory, in MB, your Lambda function is given.
void	setMode(Mode mode) How the Lambda function will be invoked.
void	setMode(String mode) How the Lambda function will be invoked.
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.
String	toString() Returns a string representation of this object; useful for testing and debugging.
UploadFunctionRequest	withDescription(String description) A short, user-defined function description.
UploadFunctionRequest	withFunctionName(String functionName) The name you want to assign to the function you are uploading.
UploadFunctionRequest	withFunctionZip(InputStream functionZip) A .zip file containing your packaged source code.
UploadFunctionRequest	withHandler(String handler) The function that Lambda calls to begin execution.
UploadFunctionRequest	withMemorySize(Integer memorySize) The amount of memory, in MB, your Lambda function is given.
UploadFunctionRequest	withMode(Mode mode) How the Lambda function will be invoked.
UploadFunctionRequest	withMode(String mode) How the Lambda function will be invoked.
UploadFunctionRequest	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.
UploadFunctionRequest	withRuntime(Runtime runtime) The runtime environment for the Lambda function you are uploading.
UploadFunctionRequest	withRuntime(String runtime) The runtime environment for the Lambda function you are uploading.
UploadFunctionRequest	withTimeout(Integer timeout) The function execution time at which Lambda should terminate the function.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UploadFunctionRequest

public UploadFunctionRequest()

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 InvokeAsync.

Constraints:
Length: 1 - 64
Pattern: [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 InvokeAsync.

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 InvokeAsync.

Constraints:
Length: 1 - 64
Pattern: [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 InvokeAsync.

withFunctionName

public UploadFunctionRequest 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 InvokeAsync.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 64
Pattern: [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 InvokeAsync.

Returns:

A reference to this updated object so that method calls can be chained together.

getFunctionZip

public InputStream getFunctionZip()

A .zip file containing your packaged source code. For more information about creating a .zip file, go to AWS LambdaL How it Works in the AWS Lambda Developer Guide. This stream must implement mark/reset in order for signature calculation to be performed before this data is read for the request payload.

Returns:

A .zip file containing your packaged source code. For more information about creating a .zip file, go to AWS LambdaL How it Works in the AWS Lambda Developer Guide.

setFunctionZip

public void setFunctionZip(InputStream functionZip)

A .zip file containing your packaged source code. For more information about creating a .zip file, go to AWS LambdaL How it Works in the AWS Lambda Developer Guide. This stream must implement mark/reset in order for signature calculation to be performed before this data is read for the request payload.

Parameters:

functionZip - A .zip file containing your packaged source code. For more information about creating a .zip file, go to AWS LambdaL How it Works in the AWS Lambda Developer Guide.

withFunctionZip

public UploadFunctionRequest withFunctionZip(InputStream functionZip)

A .zip file containing your packaged source code. For more information about creating a .zip file, go to AWS LambdaL How it Works in the AWS Lambda Developer Guide. This stream must implement mark/reset in order for signature calculation to be performed before this data is read for the request payload.

Returns a reference to this object so that method calls can be chained together.

Parameters:

functionZip - A .zip file containing your packaged source code. For more information about creating a .zip file, go to AWS LambdaL How it Works in the AWS Lambda Developer Guide.

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. Currently, Lambda supports only "nodejs" as the runtime.

Constraints:
Allowed Values: nodejs

Returns:

The runtime environment for the Lambda function you are uploading. Currently, Lambda supports only "nodejs" as the runtime.

See Also:

Runtime

setRuntime

public void setRuntime(String runtime)

The runtime environment for the Lambda function you are uploading. Currently, Lambda supports only "nodejs" as the runtime.

Constraints:
Allowed Values: nodejs

Parameters:

runtime - The runtime environment for the Lambda function you are uploading. Currently, Lambda supports only "nodejs" as the runtime.

See Also:

Runtime

withRuntime

public UploadFunctionRequest withRuntime(String runtime)

The runtime environment for the Lambda function you are uploading. Currently, Lambda supports only "nodejs" as the runtime.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: nodejs

Parameters:

runtime - The runtime environment for the Lambda function you are uploading. Currently, Lambda supports only "nodejs" as the runtime.

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. Currently, Lambda supports only "nodejs" as the runtime.

Constraints:
Allowed Values: nodejs

Parameters:

runtime - The runtime environment for the Lambda function you are uploading. Currently, Lambda supports only "nodejs" as the runtime.

See Also:

Runtime

withRuntime

public UploadFunctionRequest withRuntime(Runtime runtime)

The runtime environment for the Lambda function you are uploading. Currently, Lambda supports only "nodejs" as the runtime.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: nodejs

Parameters:

runtime - The runtime environment for the Lambda function you are uploading. Currently, Lambda supports only "nodejs" as the runtime.

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.

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.

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.

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.

withRole

public UploadFunctionRequest 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.

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.

Returns:

A reference to this updated object so that method calls can be chained together.

getHandler

public String getHandler()

The function that Lambda calls to begin execution. For Node.js, it is the module-name.export value in your function.

Constraints:
Pattern: [a-zA-Z0-9./\-_]+

Returns:

The function that Lambda calls to begin execution. For Node.js, it is the module-name.export value in your function.

setHandler

public void setHandler(String handler)

The function that Lambda calls to begin execution. For Node.js, it is the module-name.export value in your function.

Constraints:
Pattern: [a-zA-Z0-9./\-_]+

Parameters:

handler - The function that Lambda calls to begin execution. For Node.js, it is the module-name.export value in your function.

withHandler

public UploadFunctionRequest withHandler(String handler)

The function that Lambda calls to begin execution. For Node.js, it is the module-name.export value in your function.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Pattern: [a-zA-Z0-9./\-_]+

Parameters:

handler - The function that Lambda calls to begin execution. For Node.js, it is the module-name.export value in your function.

Returns:

A reference to this updated object so that method calls can be chained together.

getMode

public String getMode()

How the Lambda function will be invoked. Lambda supports only the "event" mode.

Constraints:
Allowed Values: event

Returns:

How the Lambda function will be invoked. Lambda supports only the "event" mode.

See Also:

Mode

setMode

public void setMode(String mode)

How the Lambda function will be invoked. Lambda supports only the "event" mode.

Constraints:
Allowed Values: event

Parameters:

mode - How the Lambda function will be invoked. Lambda supports only the "event" mode.

See Also:

Mode

withMode

public UploadFunctionRequest withMode(String mode)

How the Lambda function will be invoked. Lambda supports only the "event" mode.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: event

Parameters:

mode - How the Lambda function will be invoked. Lambda supports only the "event" mode.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

Mode

setMode

public void setMode(Mode mode)

How the Lambda function will be invoked. Lambda supports only the "event" mode.

Constraints:
Allowed Values: event

Parameters:

mode - How the Lambda function will be invoked. Lambda supports only the "event" mode.

See Also:

Mode

withMode

public UploadFunctionRequest withMode(Mode mode)

How the Lambda function will be invoked. Lambda supports only the "event" mode.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: event

Parameters:

mode - How the Lambda function will be invoked. Lambda supports only the "event" mode.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

Mode

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 UploadFunctionRequest 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 - 60

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 - 60

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 UploadFunctionRequest 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 - 60

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 allocated to your function. Your function use-case determines your CPU and memory requirements. For example, database operation might need less memory compared to image processing function. The default value is 128 MB. The value must be a multiple of 64 MB.

Constraints:
Range: 128 - 1024

Returns:

The amount of memory, in MB, your Lambda function is given. Lambda uses this memory size to infer the amount of CPU allocated to your function. Your function use-case determines your CPU and memory requirements. For example, database operation might need less memory compared to 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 allocated to your function. Your function use-case determines your CPU and memory requirements. For example, database operation might need less memory compared to image processing function. The default value is 128 MB. The value must be a multiple of 64 MB.

Constraints:
Range: 128 - 1024

Parameters:

memorySize - The amount of memory, in MB, your Lambda function is given. Lambda uses this memory size to infer the amount of CPU allocated to your function. Your function use-case determines your CPU and memory requirements. For example, database operation might need less memory compared to image processing function. The default value is 128 MB. The value must be a multiple of 64 MB.

withMemorySize

public UploadFunctionRequest 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 allocated to your function. Your function use-case determines your CPU and memory requirements. For example, database operation might need less memory compared to 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 - 1024

Parameters:

memorySize - The amount of memory, in MB, your Lambda function is given. Lambda uses this memory size to infer the amount of CPU allocated to your function. Your function use-case determines your CPU and memory requirements. For example, database operation might need less memory compared to 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.

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