Class CfnUrlProps.Builder

java.lang.Object
software.amazon.awscdk.services.lambda.CfnUrlProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnUrlProps>
Enclosing interface:
CfnUrlProps

@Stability(Stable) public static final class CfnUrlProps.Builder extends Object implements software.amazon.jsii.Builder<CfnUrlProps>
A builder for CfnUrlProps
  • Constructor Details

    • Builder

      public Builder()
  • Method Details

    • authType

      @Stability(Stable) public CfnUrlProps.Builder authType(String authType)
      Sets the value of CfnUrlProps.getAuthType()
      Parameters:
      authType - The type of authentication that your function URL uses. This parameter is required. 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 .
      Returns:
      this
    • targetFunctionArn

      @Stability(Stable) public CfnUrlProps.Builder targetFunctionArn(String targetFunctionArn)
      Parameters:
      targetFunctionArn - The name of the Lambda function. This parameter is required. 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:
      this
    • cors

      @Stability(Stable) public CfnUrlProps.Builder cors(IResolvable cors)
      Sets the value of CfnUrlProps.getCors()
      Parameters:
      cors - The Cross-Origin Resource Sharing (CORS) settings for your function URL.
      Returns:
      this
    • cors

      @Stability(Stable) public CfnUrlProps.Builder cors(CfnUrl.CorsProperty cors)
      Sets the value of CfnUrlProps.getCors()
      Parameters:
      cors - The Cross-Origin Resource Sharing (CORS) settings for your function URL.
      Returns:
      this
    • invokeMode

      @Stability(Stable) public CfnUrlProps.Builder invokeMode(String invokeMode)
      Sets the value of CfnUrlProps.getInvokeMode()
      Parameters:
      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 .
      Returns:
      this
    • qualifier

      @Stability(Stable) public CfnUrlProps.Builder qualifier(String qualifier)
      Sets the value of CfnUrlProps.getQualifier()
      Parameters:
      qualifier - The alias name.
      Returns:
      this
    • build

      @Stability(Stable) public CfnUrlProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnUrlProps>
      Returns:
      a new instance of CfnUrlProps
      Throws:
      NullPointerException - if any required attribute was not provided