Class: Aws::S3::Types::CORSRule
- Inherits:
-
Struct
- Object
- Struct
- Aws::S3::Types::CORSRule
- Defined in:
- gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb
Overview
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.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#allowed_headers ⇒ Array<String>
Headers that are specified in the
Access-Control-Request-Headers
header. -
#allowed_methods ⇒ Array<String>
An HTTP method that you allow the origin to execute.
-
#allowed_origins ⇒ Array<String>
One or more origins you want customers to be able to access the bucket from.
-
#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). -
#id ⇒ String
Unique identifier for the rule.
-
#max_age_seconds ⇒ Integer
The time in seconds that your browser is to cache the preflight response for the specified resource.
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.
700 701 702 703 704 705 706 707 708 709 |
# File 'gems/aws-sdk-s3/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
.
700 701 702 703 704 705 706 707 708 709 |
# File 'gems/aws-sdk-s3/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.
700 701 702 703 704 705 706 707 708 709 |
# File 'gems/aws-sdk-s3/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).
700 701 702 703 704 705 706 707 708 709 |
# File 'gems/aws-sdk-s3/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.
700 701 702 703 704 705 706 707 708 709 |
# File 'gems/aws-sdk-s3/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.
700 701 702 703 704 705 706 707 708 709 |
# File 'gems/aws-sdk-s3/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 |