Package software.amazon.awssdk.services.lambda.model

Class CreateFunctionRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.lambda.model.CreateFunctionRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<CreateFunctionRequest.Builder,CreateFunctionRequest>

@Generated("software.amazon.awssdk:codegen")
public class CreateFunctionRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<CreateFunctionRequest.Builder,CreateFunctionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateFunctionRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static CreateFunctionRequest.Builder	builder()
FunctionCode	code()	The code for the Lambda function.
DeadLetterConfig	deadLetterConfig()	The parent object that contains the target ARN (Amazon Resource Name) of an Amazon SQS queue or Amazon SNS topic.
String	description()	A short, user-defined function description.
Environment	environment()
boolean	equals(Object obj)
String	functionName()	The name you want to assign to the function you are uploading.
String	handler()	The function within your code that Lambda calls to begin execution.
int	hashCode()
String	kmsKeyArn()	The Amazon Resource Name (ARN) of the KMS key used to encrypt your function's environment variables.
Integer	memorySize()	The amount of memory, in MB, your Lambda function is given.
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.
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.
String	runtime()	The runtime environment for the Lambda function you are uploading.
static Class<? extends CreateFunctionRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags()	The list of tags (key-value pairs) assigned to the new function.
Integer	timeout()	The function execution time at which Lambda should terminate the function.
CreateFunctionRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
TracingConfig	tracingConfig()	The parent object that contains your function's tracing settings.
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 software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

functionName

public 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 API operations, such as Invoke. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.

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 API operations, such as Invoke. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.

runtime

public String runtime()

The runtime environment for the Lambda function you are uploading.

To use the Python runtime v3.6, set the value to "python3.6". To use the Python runtime v2.7, set the value to "python2.7". To use the Node.js runtime v6.10, set the value to "nodejs6.10". To use the Node.js runtime v4.3, set the value to "nodejs4.3".

Node v0.10.42 is currently marked as deprecated. You must migrate existing functions to the newer Node.js runtime versions available on AWS Lambda (nodejs4.3 or nodejs6.10) as soon as possible. You can request a one-time extension until June 30, 2017 by going to the Lambda console and following the instructions provided. Failure to do so will result in an invalid parmaeter error being returned. Note that you will have to follow this procedure for each region that contains functions written in the Node v0.10.42 runtime.

Returns:

The runtime environment for the Lambda function you are uploading.

To use the Python runtime v3.6, set the value to "python3.6". To use the Python runtime v2.7, set the value to "python2.7". To use the Node.js runtime v6.10, set the value to "nodejs6.10". To use the Node.js runtime v4.3, set the value to "nodejs4.3".

Node v0.10.42 is currently marked as deprecated. You must migrate existing functions to the newer Node.js runtime versions available on AWS Lambda (nodejs4.3 or nodejs6.10) as soon as possible. You can request a one-time extension until June 30, 2017 by going to the Lambda console and following the instructions provided. Failure to do so will result in an invalid parmaeter error being returned. Note that you will have to follow this procedure for each region that contains functions written in the Node v0.10.42 runtime.

See Also:

Runtime

role

public 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:

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.

handler

public 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:

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

code

public FunctionCode code()

The code for the Lambda function.

Returns:

The code for the Lambda function.

description

public String description()

A short, user-defined function description. Lambda does not use this value. Assign a meaningful description as you see fit.

Returns:

A short, user-defined function description. Lambda does not use this value. Assign a meaningful description as you see fit.

timeout

public 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:

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.

memorySize

public 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:

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.

publish

public 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:

This boolean parameter can be used to request AWS Lambda to create the Lambda function and publish a version as an atomic operation.

vpcConfig

public 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:

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.

deadLetterConfig

public DeadLetterConfig deadLetterConfig()

The parent object that contains the target ARN (Amazon Resource Name) of an Amazon SQS queue or Amazon SNS topic.

Returns:

The parent object that contains the target ARN (Amazon Resource Name) of an Amazon SQS queue or Amazon SNS topic.

environment

public Environment environment()

Returns:

kmsKeyArn

public String kmsKeyArn()

The Amazon Resource Name (ARN) of the KMS key used to encrypt your function's environment variables. If not provided, AWS Lambda will use a default service key.

Returns:

The Amazon Resource Name (ARN) of the KMS key used to encrypt your function's environment variables. If not provided, AWS Lambda will use a default service key.

tracingConfig

public TracingConfig tracingConfig()

The parent object that contains your function's tracing settings.

Returns:

The parent object that contains your function's tracing settings.

tags

public Map<String,String> tags()

The list of tags (key-value pairs) assigned to the new function.

Returns:

The list of tags (key-value pairs) assigned to the new function.

toBuilder

public CreateFunctionRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CreateFunctionRequest.Builder,CreateFunctionRequest>

Returns:

a builder for type T

builder

public static CreateFunctionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateFunctionRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object