aws-sdk 1.8.5 → 1.9.0

data/lib/aws/iam/collection.rb

@@ -46,7 +46,7 @@ module AWS
 
         protected
         def _each_item marker, max_items, options = {}, &block
-            
+
           prefix = options.delete(:prefix) || self.prefix
 
           options[:path_prefix] = "/#{prefix}".sub(%r{^//}, "/") if prefix

data/lib/aws/iam/config.rb

@@ -12,7 +12,7 @@
 # language governing permissions and limitations under the License.
 
 AWS::Core::Configuration.module_eval do
-  
+
   add_service 'IAM', 'iam', 'iam.amazonaws.com'
-  
+
 end

data/lib/aws/iam/group.rb

@@ -72,11 +72,11 @@ module AWS
 
       # Provides access to the users in the group.  For example:
       #
-      #   # get the names of all the users in the group
-      #   group.users.map(&:name)
+      #     # get the names of all the users in the group
+      #     group.users.map(&:name)
       #
-      #   # remove all users from the group
-      #   group.users.clear
+      #     # remove all users from the group
+      #     group.users.clear
       #
       # @return [GroupUserCollection] An object representing all the
       #   users in the group.
@@ -87,11 +87,11 @@ module AWS
       # Provides access to the policies associated with the group.
       # For example:
       #
-      #   # get the policy named "ReadOnly"
-      #   group.policies["ReadOnly"]
+      #     # get the policy named "ReadOnly"
+      #     group.policies["ReadOnly"]
       #
-      #   # remove all policies associated with the group
-      #   group.policies.clear
+      #     # remove all policies associated with the group
+      #     group.policies.clear
       #
       # @return [GroupPolicyCollection] An object representing all the
       #   policies associated with the group.

data/lib/aws/iam/group_collection.rb

@@ -17,30 +17,30 @@ module AWS
     # A collection that provides access to IAM groups
     # belonging to this account.
     #
-    #   iam = AWS::IAM.new
-    #   groups = iam.groups
+    #     iam = AWS::IAM.new
+    #     groups = iam.groups
     #
-    # == Creating a Group
+    # ## Creating a Group
     #
     # You can create a group using the {#create} method:
     #
-    #   group = iam.groups.create("Developers")
+    #     group = iam.groups.create("Developers")
     #
-    # == Getting a Group by Name
+    # ## Getting a Group by Name
     #
     # You can get a reference to a server certificate using array notation:
     #
-    #   group = iam.groups["Developers"]
+    #     group = iam.groups["Developers"]
     #
-    # == Enumerating Groups
+    # ## Enumerating Groups
     #
     # Group collections can also be used to enumerate groups:
     #
-    #   groups.each do |group|
-    #     puts group.name
-    #   end
+    #     groups.each do |group|
+    #       puts group.name
+    #     end
     #
-    # You can limit the groups returned by passing a +:prefix+ option
+    # You can limit the groups returned by passing a `:prefix` option
     # to any of the enumerator methods.  When you pass a prefix, only
     # the certificates whose paths start with the given string will be
     # returned.
@@ -69,8 +69,8 @@ module AWS
 
       # Yields once for each group.
       #
-      # You can limit the number of groups yielded using +:limit+ and
-      # +:path_prefix+.
+      # You can limit the number of groups yielded using `:limit` and
+      # `:path_prefix`.
       #
       # @param [Hash] options
       #
@@ -91,9 +91,9 @@ module AWS
 
       # Returns an enumerable object for this collection.  This can be
       # useful if you want to call an enumerable method that does
-      # not accept options (e.g. +collect+, +first+, etc).
+      # not accept options (e.g. `collect`, `first`, etc).
       #
-      #   groups.enumerator(:path_prefix => '/admin').collect(&:name)
+      #     groups.enumerator(:path_prefix => '/admin').collect(&:name)
       #
       # @param (see #each)
       # @option (see #each)
@@ -104,7 +104,7 @@ module AWS
 
       # Returns a reference to the group with the given name:
       #
-      #   group = iam.groups['groupname']
+      #     group = iam.groups['groupname']
       #
       # @param [String] name Name of the group to return a reference for.
       # @return [Group] Returns a reference to the named group.

data/lib/aws/iam/group_policy_collection.rb

@@ -19,12 +19,12 @@ module AWS
     # string keys and values that are instances of {Policy}.  For
     # example:
     #
-    #  # add or replace a policy named "ReadOnly"
-    #  policy = AWS::IAM::Policy.new do |p|
-    #    # ...
-    #  end
-    #  group.policies["ReadOnly"] = policy
-    #  group.policies.has_key?("ReadOnly")  # => true
+    #     # add or replace a policy named "ReadOnly"
+    #     policy = AWS::IAM::Policy.new do |p|
+    #       # ...
+    #     end
+    #     group.policies["ReadOnly"] = policy
+    #     group.policies.has_key?("ReadOnly")  # => true
     #
     # All of the methods for this class are defined in the
     # {PolicyCollection} module.

data/lib/aws/iam/group_user_collection.rb

@@ -17,9 +17,9 @@ module AWS
     # A collection that provides access to IAM users belonging to a
     # particular group.
     #
-    #   group = AWS::IAM.new.groups.first
-    #   users = group.users
-    #   users.each { |u| puts u.name }
+    #     group = AWS::IAM.new.groups.first
+    #     users = group.users
+    #     users.each { |u| puts u.name }
     #
     class GroupUserCollection
 

data/lib/aws/iam/mfa_device.rb

@@ -38,7 +38,7 @@ module AWS
       # @return [nil]
       def deactivate
         client.deactivate_mfa_device({
-          :user_name => user.name, 
+          :user_name => user.name,
           :serial_number => serial_number,
         })
         nil

data/lib/aws/iam/mfa_device_collection.rb

@@ -29,11 +29,11 @@ module AWS
       attr_reader :user
 
       # Enables an MFA device for this user.
-      # @param [String] serial_number The serial number that uniquely 
+      # @param [String] serial_number The serial number that uniquely
       #   identifies the MFA device
-      # @param [String] authentication_code_1 An authentication code emitted 
+      # @param [String] authentication_code_1 An authentication code emitted
       #   by the device.
-      # @param [String] authentication_code_2 A subsequent authentication 
+      # @param [String] authentication_code_2 A subsequent authentication
       #   code emitted by the device.
       # @return [MFADevice] Returns the newly enabled MFA device.
       def enable serial_number, authentication_code_1, authentication_code_2
@@ -71,21 +71,21 @@ module AWS
       #
       # @return [nil]
       def clear
-        each do |device| 
+        each do |device|
           device.deactivate
         end
         nil
       end
 
-      # Yields once for each MFA device.  
+      # Yields once for each MFA device.
       #
-      # You can limit the number of devices yielded using +:limit+.
+      # You can limit the number of devices yielded using `:limit`.
       #
       # @param [Hash] options
       # @option options [Integer] :limit The maximum number of devices to yield.
-      # @option options [Integer] :batch_size The maximum number of devices 
+      # @option options [Integer] :batch_size The maximum number of devices
       #   receive each service reqeust.
-      # @yieldparam [User] user 
+      # @yieldparam [User] user
       # @return [nil]
       def each options = {}, &block
         super(options.merge(:user_name => user.name), &block)
@@ -93,7 +93,7 @@ module AWS
 
       # Returns an enumerable object for this collection.  This can be
       # useful if you want to call an enumerable method that does
-      # not accept options (e.g. +collect+, +first+, etc).
+      # not accept options (e.g. `collect`, `first`, etc).
       #
       #   mfa_devices.enumerator(:limit => 10).collect(&:serial_number)
       #

data/lib/aws/iam/policy_collection.rb

@@ -29,7 +29,7 @@ module AWS
       # @param [String] name The name of the policy to retrieve.
       #
       # @return [Policy] The policy with the given name.  If no such
-      #   policy exists, this method returns +nil+.
+      #   policy exists, this method returns `nil`.
       def [] name
         resp = get_policy(:policy_name => name)
         Policy.from_json(URI.unescape(resp.policy_document))
@@ -42,7 +42,7 @@ module AWS
       # @param [String] name The name of the policy document.
       #
       # @param [Policy,String] document The policy document.  This can
-      #   be a JSON string, or any object that responds to +to_json+.
+      #   be a JSON string, or any object that responds to `to_json`.
       #   The {Policy} class provides a convenient way to construct
       #   policy documents that you can use with AWS IAM.
       def []= name, document
@@ -71,7 +71,7 @@ module AWS
       # @return [Array<Policy>] An array containing the requested
       #   policy documents, in the same order as the argument list.
       #   If a requested policy does not exist, the array member
-      #   corresponding to that argument will be +nil+.
+      #   corresponding to that argument will be `nil`.
       def values_at(*names)
         names.map { |n| self[n] }
       end
@@ -110,7 +110,7 @@ module AWS
       alias_method :member?, :has_key?
 
       # @yield [name, policy] The name and document for each policy
-      #   that is associated with the resource.  Like +Hash#each+,
+      #   that is associated with the resource.  Like `Hash#each`,
       #   this method is sensitive to the arity of the provided block;
       #   if the block takes two arguments, they will be the name and
       #   document.  If it accepts only one argument, it will be an

data/lib/aws/iam/resource.rb

@@ -15,7 +15,7 @@ module AWS
   class IAM
     class Resource < Core::Resource
 
-      # @return [Boolean] Returns +true+ if the resource exists.
+      # @return [Boolean] Returns `true` if the resource exists.
       def exists?
         get_resource
         true
@@ -47,7 +47,7 @@ module AWS
 
         # @private
         def prefix_update_attributes prefix = 'new_'
-          @update_prefix = prefix 
+          @update_prefix = prefix
         end
 
         # @private

data/lib/aws/iam/server_certificate.rb

@@ -16,7 +16,7 @@ module AWS
 
     # Respresents a server certificate.
     #
-    #   certificate = iam.server_certificates["MyCert"]
+    #     certificate = iam.server_certificates["MyCert"]
     #
     # You can use this class to get information about a certificate
     # and to delete it.

data/lib/aws/iam/server_certificate_collection.rb

@@ -17,16 +17,16 @@ module AWS
     # A collection that provides access to IAM server certificates
     # belonging to this account.
     #
-    #   iam = AWS::IAM.new
-    #   certificates = iam.server_certificates
+    #     iam = AWS::IAM.new
+    #     certificates = iam.server_certificates
     #
-    # == Uploading A Server Certificate
+    # ## Uploading A Server Certificate
     #
     # You can upload any valid, signed certificate using {#upload}.
     #
-    #   certificates.upload(:name => "MyCert",
-    #                       :certificate_body => my_certificate_body,
-    #                       :private_key => my_private_key)
+    #     certificates.upload(:name => "MyCert",
+    #                         :certificate_body => my_certificate_body,
+    #                         :private_key => my_private_key)
     #
     # For information about generating a server certificate for use
     # with IAM, see
@@ -34,22 +34,22 @@ module AWS
     # Creating and Uploading Server Certificates} in <i>Using AWS
     # Identity and Access Management</i>.
     #
-    # == Getting a Server Certificate by Name
+    # ## Getting a Server Certificate by Name
     #
     # You can get a reference to a server certificate using array notation:
     #
-    #   certificate = certificates['MyCert']
+    #     certificate = certificates['MyCert']
     #
-    # == Enumerating Server Certificates
+    # ## Enumerating Server Certificates
     #
     # Server certificate collections can also be used to enumerate
     # certificates:
     #
-    #   certificates.each do |cert|
-    #     puts cert.name
-    #   end
+    #     certificates.each do |cert|
+    #       puts cert.name
+    #     end
     #
-    # You can limit the certificates returned by passing a +:prefix+
+    # You can limit the certificates returned by passing a `:prefix`
     # option to any of the enumerator methods.  When you pass a
     # prefix, only the certificates whose paths start with the given
     # string will be returned.
@@ -63,7 +63,7 @@ module AWS
       # all be PEM-encoded.
       #
       # @param [Hash] options Options for uploading the certificate.
-      #   +:name+, +:certificate_body+, and +:private_key+ are
+      #   `:name`, `:certificate_body`, and `:private_key` are
       #   required.
       #
       # @option options [String] :certificate_body The contents of the
@@ -101,7 +101,7 @@ module AWS
         resp = client.upload_server_certificate(client_opts)
 
         ServerCertificate.new(
-          resp[:server_certificate_metadata][:server_certificate_name], 
+          resp[:server_certificate_metadata][:server_certificate_name],
           :config => config)
 
       end

data/lib/aws/iam/signing_certificate.rb

@@ -16,40 +16,40 @@ module AWS
     # Signing certificates can be activated and deactivated.
     # By default, newly-uploaded certifictes are active.
     #
-    #   certificate = iam.signing_certificates.upload(cert_body)
-    #   certificate.status
-    #   #=> :active
+    #     certificate = iam.signing_certificates.upload(cert_body)
+    #     certificate.status
+    #     #=> :active
     #
-    #   certificate.deactivate!
-    #   certificate.active?
-    #   #=> false
+    #     certificate.deactivate!
+    #     certificate.active?
+    #     #=> false
     #
-    # == Contents
+    # ## Contents
     #
     # You can access the certificate contents you uploaded:
     #
-    #   > puts certificate.contents
-    #   -----BEGIN CERTIFICATE-----
-    #   MIICdzCCAeCgAwIBAgIFGS4fY6owDQYJKoZIhvcNAQEFBQAwUzELMAkGA1UEBhMC
-    #   ......
-    #   Glli79yh87PRi0vNDlFEoHXNynkvC/c4TiWruZ4haM9BR9EdWr1DBNNu73ui093K
-    #   F9TbdXSWdgMl7E0=
-    #   -----END CERTIFICATE-----
+    #     > puts certificate.contents
+    #     -----BEGIN CERTIFICATE-----
+    #     MIICdzCCAeCgAwIBAgIFGS4fY6owDQYJKoZIhvcNAQEFBQAwUzELMAkGA1UEBhMC
+    #     ......
+    #     Glli79yh87PRi0vNDlFEoHXNynkvC/c4TiWruZ4haM9BR9EdWr1DBNNu73ui093K
+    #     F9TbdXSWdgMl7E0=
+    #     -----END CERTIFICATE-----
     #
-    # == User
+    # ## User
     #
     # A certificate can also return the user it belongs to.  If the certificate
-    # belongs to the AWS account, then {#user} will return +nil+.
+    # belongs to the AWS account, then {#user} will return `nil`.
     #
-    #   user = iam.users['someuser'].signing_certificates.first
-    #   user.name
-    #   #=> 'someuser'
+    #     user = iam.users['someuser'].signing_certificates.first
+    #     user.name
+    #     #=> 'someuser'
     #
-    # @attr_reader [String] contents Returns the contents of this 
+    # @attr_reader [String] contents Returns the contents of this
     #   signing certificate.
     #
     # @attr_reader [Symbol] status The status of this signing
-    #   certificate.  Status may be +:active+ or +:inactive+.
+    #   certificate.  Status may be `:active` or `:inactive`.
     #
     class SigningCertificate < Resource
 
@@ -65,9 +65,9 @@ module AWS
       # @return [String] Returns the signing certificate's ID.
       attr_reader :id
 
-      # @return [User,nil] Returns the user this cerficiate belongs to.  
-      #   Returns +nil+ if the cerficiate is a root credential for the 
-      #   account.  If the configured credentials belong to an IAM user, 
+      # @return [User,nil] Returns the user this cerficiate belongs to.
+      #   Returns `nil` if the cerficiate is a root credential for the
+      #   account.  If the configured credentials belong to an IAM user,
       #   then that user is the implied owner.
       attr_reader :user
 
@@ -78,7 +78,7 @@ module AWS
       protected :status=
 
       populates_from(
-        :upload_signing_certificate, 
+        :upload_signing_certificate,
         :update_signing_certificate
       ) do |resp|
         resp.certificate if matches_response_object?(resp.certificate)
@@ -89,7 +89,7 @@ module AWS
       end
 
       # @return [String,nil] Returns the name of the user this certificate
-      #   belogns to.  If the certificate belongs to the account, +nil+ is
+      #   belogns to.  If the certificate belongs to the account, `nil` is
       #   returned.
       def user_name
         @user ? @user.name : nil
@@ -146,9 +146,9 @@ module AWS
         identifiers
       end
 
-      # IAM does not provide a request for "get signing certificate".  
-      # Also note, we do not page the response. This is because 
-      # restrictions on how many certificates an account / user may 
+      # IAM does not provide a request for "get signing certificate".
+      # Also note, we do not page the response. This is because
+      # restrictions on how many certificates an account / user may
       # have is fewer than one page of results.
       # @private
       protected