Package software.amazon.awscdk.services.lambda

Class CfnUrl.Builder

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

  • Method Details

    • create

      @Stability(Stable) public static CfnUrl.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnUrl.Builder.

    • authType

      @Stability(Stable) public CfnUrl.Builder authType(String authType)
      The type of authentication that your function URL uses.

      Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Security and auth model for Lambda function URLs .

      Parameters:
      authType - The type of authentication that your function URL uses. This parameter is required.
      Returns:
      this

    • targetFunctionArn

      @Stability(Stable) public CfnUrl.Builder targetFunctionArn(String targetFunctionArn)
      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.

      Parameters:
      targetFunctionArn - The name of the Lambda function. This parameter is required.
      Returns:
      this

    • cors

      @Stability(Stable) public CfnUrl.Builder cors(IResolvable cors)
      The Cross-Origin Resource Sharing (CORS) settings for your function URL.

      Parameters:
      cors - The Cross-Origin Resource Sharing (CORS) settings for your function URL. This parameter is required.
      Returns:
      this

    • cors

      @Stability(Stable) public CfnUrl.Builder cors(CfnUrl.CorsProperty cors)
      The Cross-Origin Resource Sharing (CORS) settings for your function URL.

      Parameters:
      cors - The Cross-Origin Resource Sharing (CORS) settings for your function URL. This parameter is required.
      Returns:
      this

    • invokeMode

      @Stability(Stable) public CfnUrl.Builder invokeMode(String invokeMode)
      Use one of the following options:.

      • BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.
      • RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 20 MB, however, you can request a quota increase .

      Parameters:
      invokeMode - Use one of the following options:. This parameter is required.
      Returns:
      this

    • qualifier

      @Stability(Stable) public CfnUrl.Builder qualifier(String qualifier)
      The alias name.

      Parameters:
      qualifier - The alias name. This parameter is required.
      Returns:
      this

    • build

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