Class: Aws::Lambda::Types::Cors

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

Overview

Note:

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

{
  allow_credentials: false,
  allow_headers: ["Header"],
  allow_methods: ["Method"],
  allow_origins: ["Origin"],
  expose_headers: ["Header"],
  max_age: 1,
}

The cross-origin resource sharing (CORS) settings for your Lambda function URL. Use CORS to grant access to your function URL from any origin. You can also use CORS to control access for specific HTTP headers and methods in requests to your function URL.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#allow_credentialsBoolean

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

Returns:

  • (Boolean)


596
597
598
599
600
601
602
603
604
605
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 596

class Cors < Struct.new(
  :allow_credentials,
  :allow_headers,
  :allow_methods,
  :allow_origins,
  :expose_headers,
  :max_age)
  SENSITIVE = []
  include Aws::Structure
end

#allow_headersArray<String>

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

Returns:

  • (Array<String>)


596
597
598
599
600
601
602
603
604
605
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 596

class Cors < Struct.new(
  :allow_credentials,
  :allow_headers,
  :allow_methods,
  :allow_origins,
  :expose_headers,
  :max_age)
  SENSITIVE = []
  include Aws::Structure
end

#allow_methodsArray<String>

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

Returns:

  • (Array<String>)


596
597
598
599
600
601
602
603
604
605
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 596

class Cors < Struct.new(
  :allow_credentials,
  :allow_headers,
  :allow_methods,
  :allow_origins,
  :expose_headers,
  :max_age)
  SENSITIVE = []
  include Aws::Structure
end

#allow_originsArray<String>

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 (*).

Returns:

  • (Array<String>)


596
597
598
599
600
601
602
603
604
605
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 596

class Cors < Struct.new(
  :allow_credentials,
  :allow_headers,
  :allow_methods,
  :allow_origins,
  :expose_headers,
  :max_age)
  SENSITIVE = []
  include Aws::Structure
end

#expose_headersArray<String>

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.

Returns:

  • (Array<String>)


596
597
598
599
600
601
602
603
604
605
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 596

class Cors < Struct.new(
  :allow_credentials,
  :allow_headers,
  :allow_methods,
  :allow_origins,
  :expose_headers,
  :max_age)
  SENSITIVE = []
  include Aws::Structure
end

#max_ageInteger

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.

Returns:

  • (Integer)


596
597
598
599
600
601
602
603
604
605
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 596

class Cors < Struct.new(
  :allow_credentials,
  :allow_headers,
  :allow_methods,
  :allow_origins,
  :expose_headers,
  :max_age)
  SENSITIVE = []
  include Aws::Structure
end