Package software.amazon.awscdk.services.cloudfront

Class Function.Builder

java.lang.Object
software.amazon.awscdk.services.cloudfront.Function.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<Function>
Enclosing class:
Function
@Stability(Stable) public static final class Function.Builder extends Object implements software.amazon.jsii.Builder<Function>
A fluent builder for Function.

  • Method Details

    • create

      @Stability(Stable) public static Function.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of Function.Builder.

    • code

      @Stability(Stable) public Function.Builder code(FunctionCode code)
      The source code of the function.

      Parameters:
      code - The source code of the function. This parameter is required.
      Returns:
      this

    • autoPublish

      @Stability(Stable) public Function.Builder autoPublish(Boolean autoPublish)
      A flag that determines whether to automatically publish the function to the LIVE stage when it’s created.

      Default: - true

      Parameters:
      autoPublish - A flag that determines whether to automatically publish the function to the LIVE stage when it’s created. This parameter is required.
      Returns:
      this

    • comment

      @Stability(Stable) public Function.Builder comment(String comment)
      A comment to describe the function.

      Default: - same as `functionName`

      Parameters:
      comment - A comment to describe the function. This parameter is required.
      Returns:
      this

    • functionName

      @Stability(Stable) public Function.Builder functionName(String functionName)
      A name to identify the function.

      Default: - generated from the `id`

      Parameters:
      functionName - A name to identify the function. This parameter is required.
      Returns:
      this

    • keyValueStore

      @Stability(Stable) public Function.Builder keyValueStore(IKeyValueStoreRef keyValueStore)
      The Key Value Store to associate with this function.

      In order to associate a Key Value Store, the runtime must be cloudfront-js-2.0 or newer.

      Default: - no key value store is associated

      Parameters:
      keyValueStore - The Key Value Store to associate with this function. This parameter is required.
      Returns:
      this

    • runtime

      @Stability(Stable) public Function.Builder runtime(FunctionRuntime runtime)
      The runtime environment for the function.

      Default: FunctionRuntime.JS_1_0 (unless `keyValueStore` is specified, then `FunctionRuntime.JS_2_0`)

      Parameters:
      runtime - The runtime environment for the function. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public Function build()
      Specified by:
      build in interface software.amazon.jsii.Builder<Function>
      Returns:
      a newly built instance of Function.