You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::MediaStore::Types::CorsRule

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

Overview

Note:

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

{
  allowed_origins: ["Origin"],
  allowed_methods: ["PUT"], # accepts PUT, GET, DELETE, HEAD
  allowed_headers: ["Header"],
  max_age_seconds: 1,
  expose_headers: ["Header"],
}

A rule for a CORS policy. You can add up to 100 rules to a CORS policy. If more than one rule applies, the service uses the first applicable rule listed.

Instance Attribute Summary collapse

Instance Attribute Details

#allowed_headersArray<String>

Specifies which headers are allowed in a preflight OPTIONS request through the Access-Control-Request-Headers header. Each header name that is specified in Access-Control-Request-Headers must have a corresponding entry in the rule. Only the headers that were requested are sent back.

This element can contain only one wildcard character (*).

Returns:

  • (Array<String>)


119
120
121
122
123
124
125
126
# File 'gems/aws-sdk-mediastore/lib/aws-sdk-mediastore/types.rb', line 119

class CorsRule < Struct.new(
  :allowed_origins,
  :allowed_methods,
  :allowed_headers,
  :max_age_seconds,
  :expose_headers)
  include Aws::Structure
end

#allowed_methodsArray<String>

Identifies an HTTP method that the origin that is specified in the rule is allowed to execute.

Each CORS rule must contain at least one AllowedMethod and one AllowedOrigin element.

Returns:

  • (Array<String>)


119
120
121
122
123
124
125
126
# File 'gems/aws-sdk-mediastore/lib/aws-sdk-mediastore/types.rb', line 119

class CorsRule < Struct.new(
  :allowed_origins,
  :allowed_methods,
  :allowed_headers,
  :max_age_seconds,
  :expose_headers)
  include Aws::Structure
end

#allowed_originsArray<String>

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

Each CORS rule must have at least one AllowedOrigin element. The string value can include only one wildcard character (*), for example, http://*.example.com. Additionally, you can specify only one wildcard character to allow cross-origin access for all origins.

Returns:

  • (Array<String>)


119
120
121
122
123
124
125
126
# File 'gems/aws-sdk-mediastore/lib/aws-sdk-mediastore/types.rb', line 119

class CorsRule < Struct.new(
  :allowed_origins,
  :allowed_methods,
  :allowed_headers,
  :max_age_seconds,
  :expose_headers)
  include Aws::Structure
end

#expose_headersArray<String>

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

This element is optional for each rule.

Returns:

  • (Array<String>)


119
120
121
122
123
124
125
126
# File 'gems/aws-sdk-mediastore/lib/aws-sdk-mediastore/types.rb', line 119

class CorsRule < Struct.new(
  :allowed_origins,
  :allowed_methods,
  :allowed_headers,
  :max_age_seconds,
  :expose_headers)
  include Aws::Structure
end

#max_age_secondsInteger

The time in seconds that your browser caches the preflight response for the specified resource.

A CORS rule can have only one MaxAgeSeconds element.

Returns:

  • (Integer)


119
120
121
122
123
124
125
126
# File 'gems/aws-sdk-mediastore/lib/aws-sdk-mediastore/types.rb', line 119

class CorsRule < Struct.new(
  :allowed_origins,
  :allowed_methods,
  :allowed_headers,
  :max_age_seconds,
  :expose_headers)
  include Aws::Structure
end