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

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

Overview

Note:

When making an API call, you may pass CreateFunctionUrlConfigRequest data as a hash:

{
  function_name: "FunctionName", # required
  qualifier: "FunctionUrlQualifier",
  auth_type: "NONE", # required, accepts NONE, AWS_IAM
  cors: {
    allow_credentials: false,
    allow_headers: ["Header"],
    allow_methods: ["Method"],
    allow_origins: ["Origin"],
    expose_headers: ["Header"],
    max_age: 1,
  },
}

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 `IAM` 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) 


1254
1255
1256
1257
1258
1259
1260
1261
 
# File 'lib/aws-sdk-lambda/types.rb', line 1254

class CreateFunctionUrlConfigRequest < Struct.new(
  :function_name,
  :qualifier,
  :auth_type,
  :cors)
  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:



1254
1255
1256
1257
1258
1259
1260
1261
 
# File 'lib/aws-sdk-lambda/types.rb', line 1254

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

#function_name ⇒ String

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.

Returns:

  • (String) 


1254
1255
1256
1257
1258
1259
1260
1261
 
# File 'lib/aws-sdk-lambda/types.rb', line 1254

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

#qualifier ⇒ String

The alias name.

Returns:

  • (String) 


1254
1255
1256
1257
1258
1259
1260
1261
 
# File 'lib/aws-sdk-lambda/types.rb', line 1254

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