You are viewing documentation for version 1 of the AWS SDK for Ruby. Version 2 documentation can be found here.
Class: AWS::S3::CORSRuleCollection
- Inherits:
-
Object
- Object
- AWS::S3::CORSRuleCollection
- Includes:
- Core::Collection::Simple
- Defined in:
- lib/aws/s3/cors_rule_collection.rb
Overview
Manages the CORS rules for a single bucket.
Getting Rules
To get the CORS rules for a bucket, use the Bucket#cors method. This returns a CORSRuleCollection for the bucket. The collection is enumerable.
# enumerating all rules for a buck
bucket.cors.each do |rule|
# rule is a CORSRule object
end
Setting Rules
You can set the rules for a bucket (replacing all existing rules) using the #set method.
# accepts a list of one or more rules
bucket.rules.set(rule1, rule2)
# rules can be an array of rules
bucket.rules.set(rules)
# passing an empty list or array removes all rules
bucket.rules.set([])
bucket.rules.clear # does the same thing
Each rule can be a Hash, a CORSRule or another CORSRuleCollection. See Client#put_bucket_cors for a list of keys for a rule hash.
Adding Rules
Adding rules is the same as setting rules. Rules you add will be appended to the end of the existing list of rules.
# add one or more rules
bucket.rules.add(rules)
Deleting Rules
To remove a rule, use the #delete_if method.
# delete rules that allow access from any domain
bucket.cors.delete_if{|rule| rule.allowed_origins.include?('*')
Instance Attribute Summary collapse
-
#bucket ⇒ Bucket
readonly
Instance Method Summary collapse
-
#add(*rules) ⇒ nil
(also: #create)
Add one or more CORS rules to this bucket.
-
#clear ⇒ nil
Removes all CORS rules attached to this bucket.
-
#delete_if {|rule| ... } ⇒ nil
Deletes every rule for which the block evaluates to
true
. -
#initialize(bucket, options = {}) ⇒ CORSRuleCollection
constructor
A new instance of CORSRuleCollection.
-
#set(*rules) ⇒ nil
Replaces the CORS rules attached to this bucket.
Methods included from Core::Collection
#each, #each_batch, #enum, #first, #in_groups_of, #page
Constructor Details
#initialize(bucket, options = {}) ⇒ CORSRuleCollection
Returns a new instance of CORSRuleCollection
68 69 70 71 |
# File 'lib/aws/s3/cors_rule_collection.rb', line 68 def initialize bucket, = {} @bucket = bucket super end |
Instance Attribute Details
#bucket ⇒ Bucket (readonly)
74 75 76 |
# File 'lib/aws/s3/cors_rule_collection.rb', line 74 def bucket @bucket end |
Instance Method Details
#add(*rules) ⇒ nil Also known as: create
Add one or more CORS rules to this bucket.
# adding a single rule as a hash
bucket.cors.add(
:allowed_methods => %w(GET HEAD),
:allowed_origins => %w(*),
:max_age_seconds => 3600)
You can add multiple rules in a single call:
# each rule may be a hash, CORSRule or a CORSRuleCollection,
bucket.cors.add(rules)
# alternatively you can pass a list of rules
bucket.cors.add(rule1, rule2, ...)
131 132 133 |
# File 'lib/aws/s3/cors_rule_collection.rb', line 131 def add *rules self.set(self, *rules) end |
#clear ⇒ nil
Removes all CORS rules attached to this bucket.
163 164 165 166 |
# File 'lib/aws/s3/cors_rule_collection.rb', line 163 def clear client.delete_bucket_cors(:bucket_name => bucket.name) nil end |
#delete_if {|rule| ... } ⇒ nil
Deletes every rule for which the block evaluates to true
.
146 147 148 149 150 151 152 |
# File 'lib/aws/s3/cors_rule_collection.rb', line 146 def delete_if &block rules = [] self.each do |rule| rules << rule unless yield(rule) end self.set(rules) end |
#set(*rules) ⇒ nil
Replaces the CORS rules attached to this bucket. You can pass one or more rules as an array or a list.
# replace all exisitng rules with a single rule
bucket.cors.set(
:allowed_methods => %w(GET),
:allowed_origins => %w(http://*.mydomain.com),
:max_age_seconds => 3600)
If you pass an empty array, all of the rules will be removed from the bucket.
# these two lines are equivilent
bucket.cors.clear
bucket.cors.set([])
98 99 100 101 102 103 104 105 106 107 108 109 110 111 |
# File 'lib/aws/s3/cors_rule_collection.rb', line 98 def set *rules raise ArgumentError, 'expected one or more rules' if rules.empty? if rules == [[]] self.clear else rules = rule_hashes(rules) client.put_bucket_cors(:bucket_name => bucket.name, :rules => rules) end nil end |