Class: Aws::S3::Types::CORSRule

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

Overview

Note:

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

{
  id: "ID",
  allowed_headers: ["AllowedHeader"],
  allowed_methods: ["AllowedMethod"], # required
  allowed_origins: ["AllowedOrigin"], # required
  expose_headers: ["ExposeHeader"],
  max_age_seconds: 1,
}

Specifies a cross-origin access rule for an Amazon S3 bucket.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#allowed_headers ⇒ Array<String>

Headers that are specified in the ‘Access-Control-Request-Headers` header. These headers are allowed in a preflight OPTIONS request. In response to any preflight OPTIONS request, Amazon S3 returns any requested headers that are allowed.

Returns:

  • (Array<String>) 


700
701
702
703
704
705
706
707
708
709
 
# File 'lib/aws-sdk-s3/types.rb', line 700

class CORSRule < Struct.new(
  :id,
  :allowed_headers,
  :allowed_methods,
  :allowed_origins,
  :expose_headers,
  :max_age_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#allowed_methods ⇒ Array<String>

An HTTP method that you allow the origin to execute. Valid values are ‘GET`, `PUT`, `HEAD`, `POST`, and `DELETE`.

Returns:

  • (Array<String>) 


700
701
702
703
704
705
706
707
708
709
 
# File 'lib/aws-sdk-s3/types.rb', line 700

class CORSRule < Struct.new(
  :id,
  :allowed_headers,
  :allowed_methods,
  :allowed_origins,
  :expose_headers,
  :max_age_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#allowed_origins ⇒ Array<String>

One or more origins you want customers to be able to access the bucket from.

Returns:

  • (Array<String>) 


700
701
702
703
704
705
706
707
708
709
 
# File 'lib/aws-sdk-s3/types.rb', line 700

class CORSRule < Struct.new(
  :id,
  :allowed_headers,
  :allowed_methods,
  :allowed_origins,
  :expose_headers,
  :max_age_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#expose_headers ⇒ Array<String>

One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript ‘XMLHttpRequest` object).

Returns:

  • (Array<String>) 


700
701
702
703
704
705
706
707
708
709
 
# File 'lib/aws-sdk-s3/types.rb', line 700

class CORSRule < Struct.new(
  :id,
  :allowed_headers,
  :allowed_methods,
  :allowed_origins,
  :expose_headers,
  :max_age_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

Unique identifier for the rule. The value cannot be longer than 255 characters.

Returns:

  • (String) 


700
701
702
703
704
705
706
707
708
709
 
# File 'lib/aws-sdk-s3/types.rb', line 700

class CORSRule < Struct.new(
  :id,
  :allowed_headers,
  :allowed_methods,
  :allowed_origins,
  :expose_headers,
  :max_age_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#max_age_seconds ⇒ Integer

The time in seconds that your browser is to cache the preflight response for the specified resource.

Returns:

  • (Integer) 


700
701
702
703
704
705
706
707
708
709
 
# File 'lib/aws-sdk-s3/types.rb', line 700

class CORSRule < Struct.new(
  :id,
  :allowed_headers,
  :allowed_methods,
  :allowed_origins,
  :expose_headers,
  :max_age_seconds)
  SENSITIVE = []
  include Aws::Structure
end