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

Interface CreateFunctionRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateFunctionRequest.Builder,CreateFunctionRequest>, LambdaRequest.Builder, SdkBuilder<CreateFunctionRequest.Builder,CreateFunctionRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateFunctionRequest
public static interface CreateFunctionRequest.Builder extends LambdaRequest.Builder, SdkPojo, CopyableBuilder<CreateFunctionRequest.Builder,CreateFunctionRequest>

  • Method Details

    • functionName

      CreateFunctionRequest.Builder functionName(String functionName)

      The name or ARN 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.

      Parameters:
      functionName - The name or ARN 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:
      Returns a reference to this object so that method calls can be chained together.

    • runtime

      CreateFunctionRequest.Builder runtime(String runtime)

      The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive.

      The following list includes deprecated runtimes. For more information, see Runtime deprecation policy.

      Parameters:
      runtime - The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive.

      The following list includes deprecated runtimes. For more information, see Runtime deprecation policy.

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

    • runtime

      CreateFunctionRequest.Builder runtime(Runtime runtime)

      The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive.

      The following list includes deprecated runtimes. For more information, see Runtime deprecation policy.

      Parameters:
      runtime - The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive.

      The following list includes deprecated runtimes. For more information, see Runtime deprecation policy.

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

    • role

      CreateFunctionRequest.Builder role(String role)

      The Amazon Resource Name (ARN) of the function's execution role.

      Parameters:
      role - The Amazon Resource Name (ARN) of the function's execution role.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • handler

      CreateFunctionRequest.Builder handler(String handler)

      The name of the method within your code that Lambda calls to run your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Lambda programming model.

      Parameters:
      handler - The name of the method within your code that Lambda calls to run your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Lambda programming model.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • code

      CreateFunctionRequest.Builder code(FunctionCode code)

      The code for the function.

      Parameters:
      code - The code for the function.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • code

      default CreateFunctionRequest.Builder code(Consumer<FunctionCode.Builder> code)

      The code for the function.

      This is a convenience method that creates an instance of the FunctionCode.Builder avoiding the need to create one manually via FunctionCode.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to code(FunctionCode).

      Parameters:
      code - a consumer that will call methods on FunctionCode.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • description

      CreateFunctionRequest.Builder description(String description)

      A description of the function.

      Parameters:
      description - A description of the function.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • timeout

      CreateFunctionRequest.Builder timeout(Integer timeout)

      The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see Lambda execution environment.

      Parameters:
      timeout - The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see Lambda execution environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • memorySize

      CreateFunctionRequest.Builder memorySize(Integer memorySize)

      The amount of memory available to the function at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB.

      Parameters:
      memorySize - The amount of memory available to the function at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • publish

      CreateFunctionRequest.Builder publish(Boolean publish)

      Set to true to publish the first version of the function during creation.

      Parameters:
      publish - Set to true to publish the first version of the function during creation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcConfig

      CreateFunctionRequest.Builder vpcConfig(VpcConfig vpcConfig)

      For network connectivity to Amazon Web Services 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 access resources and the internet only through that VPC. For more information, see Configuring a Lambda function to access resources in a VPC.

      Parameters:
      vpcConfig - For network connectivity to Amazon Web Services 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 access resources and the internet only through that VPC. For more information, see Configuring a Lambda function to access resources in a VPC.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcConfig

      default CreateFunctionRequest.Builder vpcConfig(Consumer<VpcConfig.Builder> vpcConfig)

      For network connectivity to Amazon Web Services 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 access resources and the internet only through that VPC. For more information, see Configuring a Lambda function to access resources in a VPC.

      This is a convenience method that creates an instance of the VpcConfig.Builder avoiding the need to create one manually via VpcConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to vpcConfig(VpcConfig).

      Parameters:
      vpcConfig - a consumer that will call methods on VpcConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • packageType

      CreateFunctionRequest.Builder packageType(String packageType)

      The type of deployment package. Set to Image for container image and set to Zip for .zip file archive.

      Parameters:
      packageType - The type of deployment package. Set to Image for container image and set to Zip for .zip file archive.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • packageType

      CreateFunctionRequest.Builder packageType(PackageType packageType)

      The type of deployment package. Set to Image for container image and set to Zip for .zip file archive.

      Parameters:
      packageType - The type of deployment package. Set to Image for container image and set to Zip for .zip file archive.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • deadLetterConfig

      CreateFunctionRequest.Builder deadLetterConfig(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • deadLetterConfig

      default CreateFunctionRequest.Builder deadLetterConfig(Consumer<DeadLetterConfig.Builder> 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.

      This is a convenience method that creates an instance of the DeadLetterConfig.Builder avoiding the need to create one manually via DeadLetterConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to deadLetterConfig(DeadLetterConfig).

      Parameters:
      deadLetterConfig - a consumer that will call methods on DeadLetterConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • environment

      CreateFunctionRequest.Builder environment(Environment environment)

      Environment variables that are accessible from function code during execution.

      Parameters:
      environment - Environment variables that are accessible from function code during execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • environment

      default CreateFunctionRequest.Builder environment(Consumer<Environment.Builder> environment)

      Environment variables that are accessible from function code during execution.

      This is a convenience method that creates an instance of the Environment.Builder avoiding the need to create one manually via Environment.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to environment(Environment).

      Parameters:
      environment - a consumer that will call methods on Environment.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • kmsKeyArn

      CreateFunctionRequest.Builder kmsKeyArn(String kmsKeyArn)

      The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt your function's environment variables. When Lambda SnapStart is activated, Lambda also uses this key is to encrypt your function's snapshot. If you deploy your function using a container image, Lambda also uses this key to encrypt your function when it's deployed. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). If you don't provide a customer managed key, Lambda uses a default service key.

      Parameters:
      kmsKeyArn - The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt your function's environment variables. When Lambda SnapStart is activated, Lambda also uses this key is to encrypt your function's snapshot. If you deploy your function using a container image, Lambda also uses this key to encrypt your function when it's deployed. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). If you don't provide a customer managed key, Lambda uses a default service key.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tracingConfig

      CreateFunctionRequest.Builder tracingConfig(TracingConfig tracingConfig)

      Set Mode to Active to sample and trace a subset of incoming requests with X-Ray.

      Parameters:
      tracingConfig - Set Mode to Active to sample and trace a subset of incoming requests with X-Ray.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tracingConfig

      default CreateFunctionRequest.Builder tracingConfig(Consumer<TracingConfig.Builder> tracingConfig)

      Set Mode to Active to sample and trace a subset of incoming requests with X-Ray.

      This is a convenience method that creates an instance of the TracingConfig.Builder avoiding the need to create one manually via TracingConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tracingConfig(TracingConfig).

      Parameters:
      tracingConfig - a consumer that will call methods on TracingConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      CreateFunctionRequest.Builder tags(Map<String,String> tags)

      A list of tags to apply to the function.

      Parameters:
      tags - A list of tags to apply to the function.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • layers

      CreateFunctionRequest.Builder layers(Collection<String> layers)

      A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.

      Parameters:
      layers - A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • layers

      CreateFunctionRequest.Builder layers(String... layers)

      A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.

      Parameters:
      layers - A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fileSystemConfigs

      CreateFunctionRequest.Builder fileSystemConfigs(Collection<FileSystemConfig> fileSystemConfigs)

      Connection settings for an Amazon EFS file system.

      Parameters:
      fileSystemConfigs - Connection settings for an Amazon EFS file system.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fileSystemConfigs

      CreateFunctionRequest.Builder fileSystemConfigs(FileSystemConfig... fileSystemConfigs)

      Connection settings for an Amazon EFS file system.

      Parameters:
      fileSystemConfigs - Connection settings for an Amazon EFS file system.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fileSystemConfigs

      CreateFunctionRequest.Builder fileSystemConfigs(Consumer<FileSystemConfig.Builder>... fileSystemConfigs)

      Connection settings for an Amazon EFS file system.

      This is a convenience method that creates an instance of the FileSystemConfig.Builder avoiding the need to create one manually via FileSystemConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to fileSystemConfigs(List<FileSystemConfig>).

      Parameters:
      fileSystemConfigs - a consumer that will call methods on FileSystemConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • imageConfig

      CreateFunctionRequest.Builder imageConfig(ImageConfig imageConfig)

      Container image configuration values that override the values in the container image Dockerfile.

      Parameters:
      imageConfig - Container image configuration values that override the values in the container image Dockerfile.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • imageConfig

      default CreateFunctionRequest.Builder imageConfig(Consumer<ImageConfig.Builder> imageConfig)

      Container image configuration values that override the values in the container image Dockerfile.

      This is a convenience method that creates an instance of the ImageConfig.Builder avoiding the need to create one manually via ImageConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to imageConfig(ImageConfig).

      Parameters:
      imageConfig - a consumer that will call methods on ImageConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • codeSigningConfigArn

      CreateFunctionRequest.Builder codeSigningConfigArn(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • architecturesWithStrings

      CreateFunctionRequest.Builder architecturesWithStrings(Collection<String> architectures)

      The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is x86_64.

      Parameters:
      architectures - The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is x86_64.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • architecturesWithStrings

      CreateFunctionRequest.Builder architecturesWithStrings(String... architectures)

      The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is x86_64.

      Parameters:
      architectures - The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is x86_64.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • architectures

      CreateFunctionRequest.Builder architectures(Collection<Architecture> architectures)

      The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is x86_64.

      Parameters:
      architectures - The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is x86_64.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • architectures

      CreateFunctionRequest.Builder architectures(Architecture... architectures)

      The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is x86_64.

      Parameters:
      architectures - The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is x86_64.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ephemeralStorage

      CreateFunctionRequest.Builder ephemeralStorage(EphemeralStorage ephemeralStorage)

      The size of the function's /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10,240 MB. For more information, see Configuring ephemeral storage (console).

      Parameters:
      ephemeralStorage - The size of the function's /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10,240 MB. For more information, see Configuring ephemeral storage (console).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ephemeralStorage

      default CreateFunctionRequest.Builder ephemeralStorage(Consumer<EphemeralStorage.Builder> ephemeralStorage)

      The size of the function's /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10,240 MB. For more information, see Configuring ephemeral storage (console).

      This is a convenience method that creates an instance of the EphemeralStorage.Builder avoiding the need to create one manually via EphemeralStorage.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to ephemeralStorage(EphemeralStorage).

      Parameters:
      ephemeralStorage - a consumer that will call methods on EphemeralStorage.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • snapStart

      CreateFunctionRequest.Builder snapStart(SnapStart snapStart)

      The function's SnapStart setting.

      Parameters:
      snapStart - The function's SnapStart setting.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • snapStart

      default CreateFunctionRequest.Builder snapStart(Consumer<SnapStart.Builder> snapStart)

      The function's SnapStart setting.

      This is a convenience method that creates an instance of the SnapStart.Builder avoiding the need to create one manually via SnapStart.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to snapStart(SnapStart).

      Parameters:
      snapStart - a consumer that will call methods on SnapStart.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • loggingConfig

      CreateFunctionRequest.Builder loggingConfig(LoggingConfig loggingConfig)

      The function's Amazon CloudWatch Logs configuration settings.

      Parameters:
      loggingConfig - The function's Amazon CloudWatch Logs configuration settings.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • loggingConfig

      default CreateFunctionRequest.Builder loggingConfig(Consumer<LoggingConfig.Builder> loggingConfig)

      The function's Amazon CloudWatch Logs configuration settings.

      This is a convenience method that creates an instance of the LoggingConfig.Builder avoiding the need to create one manually via LoggingConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to loggingConfig(LoggingConfig).

      Parameters:
      loggingConfig - a consumer that will call methods on LoggingConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreateFunctionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateFunctionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.