Skip to content

CreateFunctionUrlConfigRequest

Source code in docs_src/capo_lambda/types/create_function_url_config_request.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class CreateFunctionUrlConfigRequest(TypedDict, closed=True):
    function_name: (
        "capo_lambda.types.function_url_function_name.FunctionUrlFunctionName"
    )
    """<p>The name or ARN of the Lambda function.</p> <p class="title"> <b>Name formats</b> </p> <ul> <li> <p> <b>Function name</b> – <code>my-function</code>.</p> </li> <li> <p> <b>Function ARN</b> – <code>arn:aws:lambda:us-west-2:123456789012:function:my-function</code>.</p> </li> <li> <p> <b>Partial ARN</b> – <code>123456789012:function:my-function</code>.</p> </li> </ul> <p>The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.</p>"""
    qualifier: NotRequired[
        "capo_lambda.types.function_url_qualifier.FunctionUrlQualifier"
    ]
    """<p>The alias name.</p>"""
    auth_type: "capo_lambda.types.function_url_auth_type.FunctionUrlAuthType"
    """<p>The type of authentication that your function URL uses. Set to <code>AWS_IAM</code> if you want to restrict access to authenticated users only. Set to <code>NONE</code> if you want to bypass IAM authentication to create a public endpoint. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html">Control access to Lambda function URLs</a>.</p>"""
    cors: NotRequired["capo_lambda.types.cors.Cors"]
    """<p>The <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS">cross-origin resource sharing (CORS)</a> settings for your function URL.</p>"""
    invoke_mode: NotRequired["capo_lambda.types.invoke_mode.InvokeMode"]
    """<p>Use one of the following options:</p> <ul> <li> <p> <code>BUFFERED</code> – This is the default option. Lambda invokes your function using the <code>Invoke</code> API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.</p> </li> <li> <p> <code>RESPONSE_STREAM</code> – Your function streams payload results as they become available. Lambda invokes your function using the <code>InvokeWithResponseStream</code> API operation. The maximum response payload size is 200 MB.</p> </li> </ul>"""

auth_type instance-attribute 

auth_type: FunctionUrlAuthType

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 Control access to Lambda function URLs.

cors instance-attribute 

cors: NotRequired[Cors]

The cross-origin resource sharing (CORS) settings for your function URL.

function_name instance-attribute 

function_name: FunctionUrlFunctionName

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.

invoke_mode instance-attribute 

invoke_mode: NotRequired[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 200 MB.

qualifier instance-attribute 

qualifier: NotRequired[FunctionUrlQualifier]

The alias name.