Class: Aws::Lightsail::Types::BucketCorsRule

Inherits:

Struct

• Object
• Struct
• Aws::Lightsail::Types::BucketCorsRule

Defined in:

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

Overview

Describes a cross-origin resource sharing (CORS) rule for a Lightsail bucket. CORS rules specify which origins are allowed to access the bucket, which HTTP methods are allowed, and other access control information. For more information, see Configuring cross-origin resource sharing (CORS).

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #allowed_headers ⇒ Array<String>

  Headers that are specified in the Access-Control-Request-Headers header.

• #allowed_methods ⇒ Array<String>

  The HTTP methods that are allowed when accessing the bucket from the specified origin.

• #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

  A unique identifier for the CORS 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.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1386

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

#allowed_methods ⇒ Array<String>

The HTTP methods that are allowed when accessing the bucket from the specified origin. Each CORS rule must identify at least one origin and one method.

You can use the following HTTP methods:

• GET - Retrieves data from the server, such as downloading files or viewing content.

• PUT - Uploads or replaces data on the server, such as uploading new files.

• POST - Sends data to the server for processing, such as submitting forms or creating new resources.

• DELETE - Removes data from the server, such as deleting files or resources.

• HEAD - Retrieves only the headers from the server without the actual content, useful for checking if a resource exists.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1386

class BucketCorsRule < Struct.new(
  :id,
  :allowed_methods,
  :allowed_origins,
  :allowed_headers,
  :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. Each CORS rule must identify at least one origin and one method.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1386

class BucketCorsRule < Struct.new(
  :id,
  :allowed_methods,
  :allowed_origins,
  :allowed_headers,
  :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>)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1386

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

#id ⇒ String

A unique identifier for the CORS rule. The ID value can be up to 255 characters long. The IDs help you find a rule in the configuration.

Returns:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1386

class BucketCorsRule < Struct.new(
  :id,
  :allowed_methods,
  :allowed_origins,
  :allowed_headers,
  :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. A CORS rule can have only one maxAgeSeconds element.

Returns:

• (Integer)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1386

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