Class: Aws::ApiGatewayV2::Types::Cors

Inherits:

Struct

• Object
• Struct
• Aws::ApiGatewayV2::Types::Cors

Defined in:

gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb

Overview

Note:

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

{
  allow_credentials: false,
  allow_headers: ["__string"],
  allow_methods: ["StringWithLengthBetween1And64"],
  allow_origins: ["__string"],
  expose_headers: ["__string"],
  max_age: 1,
}

Represents a CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #allow_credentials ⇒ Boolean

  Specifies whether credentials are included in the CORS request.

• #allow_headers ⇒ Array<String>

  Represents a collection of allowed headers.

• #allow_methods ⇒ Array<String>

  Represents a collection of allowed HTTP methods.

• #allow_origins ⇒ Array<String>

  Represents a collection of allowed origins.

• #expose_headers ⇒ Array<String>

  Represents a collection of exposed headers.

• #max_age ⇒ Integer

  The number of seconds that the browser should cache preflight request results.

Instance Attribute Details

#allow_credentials ⇒ Boolean

Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.

Returns:

• (Boolean)

# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 442

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

#allow_headers ⇒ Array<String>

Represents a collection of allowed headers. Supported only for HTTP APIs.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 442

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

#allow_methods ⇒ Array<String>

Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 442

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

#allow_origins ⇒ Array<String>

Represents a collection of allowed origins. Supported only for HTTP APIs.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 442

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

#expose_headers ⇒ Array<String>

Represents a collection of exposed headers. Supported only for HTTP APIs.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 442

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

#max_age ⇒ Integer

The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.

Returns:

• (Integer)

# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 442

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