Class: Aws::Lambda::Types::CreateFunctionUrlConfigRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-lambda/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#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].

[1]: docs.aws.amazon.com/lambda/latest/dg/urls-auth.html

Returns:

  • (String) 


1202
1203
1204
1205
1206
1207
1208
1209
1210
 
# File 'lib/aws-sdk-lambda/types.rb', line 1202

class CreateFunctionUrlConfigRequest < Struct.new(
  :function_name,
  :qualifier,
  :auth_type,
  :cors,
  :invoke_mode)
  SENSITIVE = []
  include Aws::Structure
end

#cors ⇒ Types::Cors

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

[1]: developer.mozilla.org/en-US/docs/Web/HTTP/CORS

Returns:



1202
1203
1204
1205
1206
1207
1208
1209
1210
 
# File 'lib/aws-sdk-lambda/types.rb', line 1202

class CreateFunctionUrlConfigRequest < Struct.new(
  :function_name,
  :qualifier,
  :auth_type,
  :cors,
  :invoke_mode)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

  • (String) 


1202
1203
1204
1205
1206
1207
1208
1209
1210
 
# File 'lib/aws-sdk-lambda/types.rb', line 1202

class CreateFunctionUrlConfigRequest < Struct.new(
  :function_name,
  :qualifier,
  :auth_type,
  :cors,
  :invoke_mode)
  SENSITIVE = []
  include Aws::Structure
end

#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].

[1]: docs.aws.amazon.com/servicequotas/latest/userguide/request-quota-increase.html

Returns:

  • (String) 


1202
1203
1204
1205
1206
1207
1208
1209
1210
 
# File 'lib/aws-sdk-lambda/types.rb', line 1202

class CreateFunctionUrlConfigRequest < Struct.new(
  :function_name,
  :qualifier,
  :auth_type,
  :cors,
  :invoke_mode)
  SENSITIVE = []
  include Aws::Structure
end

#qualifier ⇒ String

The alias name.

Returns:

  • (String) 


1202
1203
1204
1205
1206
1207
1208
1209
1210
 
# File 'lib/aws-sdk-lambda/types.rb', line 1202

class CreateFunctionUrlConfigRequest < Struct.new(
  :function_name,
  :qualifier,
  :auth_type,
  :cors,
  :invoke_mode)
  SENSITIVE = []
  include Aws::Structure
end