AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . lambda ]

create-function-url-config

Description

Creates a Lambda function URL with the specified configuration parameters. A function URL is a dedicated HTTP(S) endpoint that you can use to invoke your function.

See also: AWS API Documentation

Synopsis

  create-function-url-config
--function-name <value>
[--qualifier <value>]
--auth-type <value>
[--cors <value>]
[--invoke-mode <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--function-name (string)

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.

--qualifier (string)

The alias name.

--auth-type (string)

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 .

Possible values:

  • NONE
  • AWS_IAM

--cors (structure)

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

AllowCredentials -> (boolean)

Whether to allow cookies or other credentials in requests to your function URL. The default is false .

AllowHeaders -> (list)

The HTTP headers that origins can include in requests to your function URL. For example: Date , Keep-Alive , X-Custom-Header .

(string)

AllowMethods -> (list)

The HTTP methods that are allowed when calling your function URL. For example: GET , POST , DELETE , or the wildcard character (* ).

(string)

AllowOrigins -> (list)

The origins that can access your function URL. You can list any number of specific origins, separated by a comma. For example: https://www.example.com , http://localhost:60905 .

Alternatively, you can grant access to all origins using the wildcard character (* ).

(string)

ExposeHeaders -> (list)

The HTTP headers in your function response that you want to expose to origins that call your function URL. For example: Date , Keep-Alive , X-Custom-Header .

(string)

MaxAge -> (integer)

The maximum amount of time, in seconds, that web browsers can cache results of a preflight request. By default, this is set to 0 , which means that the browser doesn't cache results.

Shorthand Syntax:

AllowCredentials=boolean,AllowHeaders=string,string,AllowMethods=string,string,AllowOrigins=string,string,ExposeHeaders=string,string,MaxAge=integer

JSON Syntax:

{
  "AllowCredentials": true|false,
  "AllowHeaders": ["string", ...],
  "AllowMethods": ["string", ...],
  "AllowOrigins": ["string", ...],
  "ExposeHeaders": ["string", ...],
  "MaxAge": integer
}

--invoke-mode (string)

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 .

Possible values:

  • BUFFERED
  • RESPONSE_STREAM

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

FunctionUrl -> (string)

The HTTP URL endpoint for your function.

FunctionArn -> (string)

The Amazon Resource Name (ARN) of your function.

AuthType -> (string)

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 .

Cors -> (structure)

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

AllowCredentials -> (boolean)

Whether to allow cookies or other credentials in requests to your function URL. The default is false .

AllowHeaders -> (list)

The HTTP headers that origins can include in requests to your function URL. For example: Date , Keep-Alive , X-Custom-Header .

(string)

AllowMethods -> (list)

The HTTP methods that are allowed when calling your function URL. For example: GET , POST , DELETE , or the wildcard character (* ).

(string)

AllowOrigins -> (list)

The origins that can access your function URL. You can list any number of specific origins, separated by a comma. For example: https://www.example.com , http://localhost:60905 .

Alternatively, you can grant access to all origins using the wildcard character (* ).

(string)

ExposeHeaders -> (list)

The HTTP headers in your function response that you want to expose to origins that call your function URL. For example: Date , Keep-Alive , X-Custom-Header .

(string)

MaxAge -> (integer)

The maximum amount of time, in seconds, that web browsers can cache results of a preflight request. By default, this is set to 0 , which means that the browser doesn't cache results.

CreationTime -> (string)

When the function URL was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

InvokeMode -> (string)

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 .