CreateFunctionRequest (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.lambda.model.LambdaRequest
    - - software.amazon.awssdk.services.lambda.model.CreateFunctionRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateFunctionRequest.Builder,CreateFunctionRequest>

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateFunctionRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateFunctionRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CreateFunctionRequest.Builder`	`builder()`
`FunctionCode`	`code()` The code for the function.
`DeadLetterConfig`	`deadLetterConfig()` A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing.
`String`	`description()` A description of the function.
`Environment`	`environment()` Environment variables that are accessible from function code during execution.
`boolean`	`equals(Object obj)`
`String`	`functionName()` The name of the Lambda function.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`String`	`handler()` The name of the method within your code that Lambda calls to execute your function.
`int`	`hashCode()`
`String`	`kmsKeyArn()` The ARN of the KMS key used to encrypt your function's environment variables.
`List<String>`	`layers()` A list of function layers to add to the function's execution environment.
`Integer`	`memorySize()` The amount of memory that your function has access to.
`Boolean`	`publish()` Set to true to publish the first version of the function during creation.
`String`	`role()` The Amazon Resource Name (ARN) of the function's execution role.
`Runtime`	`runtime()` The runtime version for the function.
`String`	`runtimeAsString()` The runtime version for the function.
`List<SdkField<?>>`	`sdkFields()`
`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 amount of time that Lambda allows a function to run before terminating it.
`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()` Set `Mode` to `Active` to sample and trace a subset of incoming requests with AWS X-Ray.
`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.awscore.AwsRequest
overrideConfiguration

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - functionName
```
public String functionName()
```
    The name of the Lambda function.
    
    Name formats
    - Function name - MyFunction.
    - Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
    - Partial ARN - 123456789012:function:MyFunction.
    The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
    Returns:
    The name of the Lambda function.
    
    Name formats
    
    Function name - MyFunction.
    
    Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
    
    Partial ARN - 123456789012:function:MyFunction.
    
    The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
  - runtime
```
public Runtime runtime()
```
    The runtime version for the function.
    
    If the service returns an enum value that is not available in the current SDK version, runtime will return Runtime.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from runtimeAsString().
    
    Returns:
    
    The runtime version for the function.
    
    See Also:
    
    Runtime
  - runtimeAsString
```
public String runtimeAsString()
```
    The runtime version for the function.
    
    If the service returns an enum value that is not available in the current SDK version, runtime will return Runtime.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from runtimeAsString().
    
    Returns:
    
    The runtime version for the function.
    
    See Also:
    
    Runtime
  - role
```
public String role()
```
    The Amazon Resource Name (ARN) of the function's execution role.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the function's execution role.
  - handler
```
public String handler()
```
    The name of the method within your code that Lambda calls to execute your function. For more information, see Programming Model.
    
    Returns:
    
    The name of the method within your code that Lambda calls to execute your function. For more information, see Programming Model.
  - code
```
public FunctionCode code()
```
    The code for the function.
    
    Returns:
    
    The code for the function.
  - description
```
public String description()
```
    A description of the function.
    
    Returns:
    
    A description of the function.
  - timeout
```
public Integer timeout()
```
    The amount of time that Lambda allows a function to run before terminating it. The default is 3 seconds. The maximum allowed value is 900 seconds.
    
    Returns:
    
    The amount of time that Lambda allows a function to run before terminating it. The default is 3 seconds. The maximum allowed value is 900 seconds.
  - memorySize
```
public Integer memorySize()
```
    The amount of memory that your function has access to. Increasing the function's memory also increases it's CPU allocation. The default value is 128 MB. The value must be a multiple of 64 MB.
    
    Returns:
    
    The amount of memory that your function has access to. Increasing the function's memory also increases it's CPU allocation. The default value is 128 MB. The value must be a multiple of 64 MB.
  - publish
```
public Boolean publish()
```
    Set to true to publish the first version of the function during creation.
    
    Returns:
    
    Set to true to publish the first version of the function during creation.
  - 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()
```
    A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead Letter Queues.
    
    Returns:
    
    A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead Letter Queues.
  - environment
```
public Environment environment()
```
    Environment variables that are accessible from function code during execution.
    
    Returns:
    
    Environment variables that are accessible from function code during execution.
  - kmsKeyArn
```
public String kmsKeyArn()
```
    The 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 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()
```
    Set Mode to Active to sample and trace a subset of incoming requests with AWS X-Ray.
    
    Returns:
    
    Set Mode to Active to sample and trace a subset of incoming requests with AWS X-Ray.
  - tags
```
public Map<String,String> tags()
```
    The list of tags (key-value pairs) assigned to the new function. For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The list of tags (key-value pairs) assigned to the new function. For more information, see Tagging Lambda Functions in the AWS Lambda Developer Guide.
  - layers
```
public List<String> layers()
```
    A list of function layers to add to the function's execution environment.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    A list of function layers to add to the function's execution environment.
  - 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>
    
    Specified by:
    
    toBuilder in class LambdaRequest
    
    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
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class CreateFunctionRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

functionName

runtime

runtimeAsString

role

handler

code

description

timeout

memorySize

publish

vpcConfig

deadLetterConfig

environment

kmsKeyArn

tracingConfig

tags

layers

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields