CreateFunctionRequest (AWS Java SDK :: Services

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.
`String`	`codeSigningConfigArn()` To enable code signing for this function, specify the ARN of a code-signing configuration.
`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)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<FileSystemConfig>`	`fileSystemConfigs()` Connection settings for an Amazon EFS file system.
`String`	`functionName()` The name of the Lambda function.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`String`	`handler()` The name of the method within your code that Lambda calls to execute your function.
`boolean`	`hasFileSystemConfigs()` Returns true if the FileSystemConfigs property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasLayers()` Returns true if the Layers property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`ImageConfig`	`imageConfig()` Container image configuration values that override the values in the container image Dockerfile.
`String`	`kmsKeyArn()` The ARN of the AWS Key Management Service (AWS KMS) key that's 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 available to the function at runtime.
`PackageType`	`packageType()` The type of deployment package.
`String`	`packageTypeAsString()` The type of deployment package.
`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 identifier of the function's runtime.
`String`	`runtimeAsString()` The identifier of the function's runtime.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateFunctionRequest.Builder>`	`serializableBuilderClass()`
`Map<String,String>`	`tags()` A list of tags to apply to the function.
`Integer`	`timeout()` The amount of time that Lambda allows a function to run before stopping it.
`CreateFunctionRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`TracingConfig`	`tracingConfig()` Set `Mode` to `Active` to sample and trace a subset of incoming requests with AWS X-Ray.
`VpcConfig`	`vpcConfig()` For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC.

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

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

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

- Method Detail
  - functionName
```
public final String functionName()
```
    The name of the Lambda function.
    
    Name formats
    - Function name - my-function.
    - Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
    - Partial ARN - 123456789012:function:my-function.
    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 - my-function.
    
    Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
    
    Partial ARN - 123456789012:function:my-function.
    
    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 final Runtime runtime()
```
    The identifier of the function's runtime.
    
    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 identifier of the function's runtime.
    
    See Also:
    
    Runtime
  - runtimeAsString
```
public final String runtimeAsString()
```
    The identifier of the function's runtime.
    
    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 identifier of the function's runtime.
    
    See Also:
    
    Runtime
  - role
```
public final 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 final String handler()
```
    The name of the method within your code that Lambda calls to execute your function. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Programming Model.
    
    Returns:
    
    The name of the method within your code that Lambda calls to execute your function. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Programming Model.
  - code
```
public final FunctionCode code()
```
    The code for the function.
    
    Returns:
    
    The code for the function.
  - description
```
public final String description()
```
    A description of the function.
    
    Returns:
    
    A description of the function.
  - timeout
```
public final Integer timeout()
```
    The amount of time that Lambda allows a function to run before stopping 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 stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds.
  - memorySize
```
public final Integer memorySize()
```
    The amount of memory available to the function at runtime. Increasing the function's memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB.
    
    Returns:
    
    The amount of memory available to the function at runtime. Increasing the function's memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB.
  - publish
```
public final 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 final VpcConfig vpcConfig()
```
    For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can only access resources and the internet through that VPC. For more information, see VPC Settings.
    
    Returns:
    
    For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can only access resources and the internet through that VPC. For more information, see VPC Settings.
  - packageType
```
public final PackageType packageType()
```
    The type of deployment package. Set to Image for container image and set Zip for ZIP archive.
    
    If the service returns an enum value that is not available in the current SDK version, packageType will return PackageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from packageTypeAsString().
    
    Returns:
    
    The type of deployment package. Set to Image for container image and set Zip for ZIP archive.
    
    See Also:
    
    PackageType
  - packageTypeAsString
```
public final String packageTypeAsString()
```
    The type of deployment package. Set to Image for container image and set Zip for ZIP archive.
    
    If the service returns an enum value that is not available in the current SDK version, packageType will return PackageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from packageTypeAsString().
    
    Returns:
    
    The type of deployment package. Set to Image for container image and set Zip for ZIP archive.
    
    See Also:
    
    PackageType
  - deadLetterConfig
```
public final 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 final 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 final String kmsKeyArn()
```
    The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key.
    
    Returns:
    
    The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key.
  - tracingConfig
```
public final 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.
  - hasTags
```
public final boolean hasTags()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tags
```
public final Map<String,String> tags()
```
    A list of tags to apply to the function.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    A list of tags to apply to the function.
  - hasLayers
```
public final boolean hasLayers()
```
    Returns true if the Layers property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - layers
```
public final List<String> layers()
```
    A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasLayers() to see if a value was sent in this field.
    
    Returns:
    
    A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.
  - hasFileSystemConfigs
```
public final boolean hasFileSystemConfigs()
```
    Returns true if the FileSystemConfigs property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - fileSystemConfigs
```
public final List<FileSystemConfig> fileSystemConfigs()
```
    Connection settings for an Amazon EFS file system.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasFileSystemConfigs() to see if a value was sent in this field.
    
    Returns:
    
    Connection settings for an Amazon EFS file system.
  - imageConfig
```
public final ImageConfig imageConfig()
```
    Container image configuration values that override the values in the container image Dockerfile.
    
    Returns:
    
    Container image configuration values that override the values in the container image Dockerfile.
  - codeSigningConfigArn
```
public final String codeSigningConfigArn()
```
    To enable code signing for this function, specify the ARN of a code-signing configuration. A code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.
    
    Returns:
    
    To enable code signing for this function, specify the ARN of a code-signing configuration. A code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.
  - toBuilder
```
public CreateFunctionRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateFunctionRequest.Builder,CreateFunctionRequest>
    
    Specified by:
    
    toBuilder in class LambdaRequest
  - builder
```
public static CreateFunctionRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateFunctionRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

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

packageType

packageTypeAsString

deadLetterConfig

environment

kmsKeyArn

tracingConfig

hasTags

tags

hasLayers

layers

hasFileSystemConfigs

fileSystemConfigs

imageConfig

codeSigningConfigArn

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields