Interface CfnUrlProps

All Superinterfaces:
All Known Implementing Classes:

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:40.680Z") @Stability(Stable) public interface CfnUrlProps extends
Properties for defining a CfnUrl.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 CfnUrlProps cfnUrlProps = CfnUrlProps.builder()
         // the properties below are optional
  • Method Details

    • getAuthType

      @Stability(Stable) @NotNull String getAuthType()
      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 .

    • getTargetFunctionArn

      @Stability(Stable) @NotNull String getTargetFunctionArn()
      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.

    • getCors

      @Stability(Stable) @Nullable default Object getCors()
      The Cross-Origin Resource Sharing (CORS) settings for your function URL.
    • getInvokeMode

      @Stability(Stable) @Nullable default String getInvokeMode()
      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 .
    • getQualifier

      @Stability(Stable) @Nullable default String getQualifier()
      The alias name.
    • builder

      @Stability(Stable) static CfnUrlProps.Builder builder()
      a CfnUrlProps.Builder of CfnUrlProps