aws-sdk 1.8.5 → 1.9.0

data/lib/aws/iam/signing_certificate_collection.rb

@@ -16,32 +16,32 @@ module AWS
     # This is the primary interface for uploading X.509 signing certificates
     # to an AWS account or an IAM user.
     #
-    #   iam = AWS::IAM.new
+    #     iam = AWS::IAM.new
     #
-    #   # upload a certificate for the AWS account:
-    #   iam.signing_certificates.upload(<<-CERT)
-    #   -----BEGIN CERTIFICATE-----
-    #   MIICdzCCAeCgAwIBAgIFGS4fY6owDQYJKoZIhvcNAQEFBQAwUzELMAkGA1UEBhMC
-    #   ......
-    #   Glli79yh87PRi0vNDlFEoHXNynkvC/c4TiWruZ4haM9BR9EdWr1DBNNu73ui093K
-    #   F9TbdXSWdgMl7E0=
-    #   -----END CERTIFICATE-----
-    #   CERT
+    #     # upload a certificate for the AWS account:
+    #     iam.signing_certificates.upload(<<-CERT)
+    #     -----BEGIN CERTIFICATE-----
+    #     MIICdzCCAeCgAwIBAgIFGS4fY6owDQYJKoZIhvcNAQEFBQAwUzELMAkGA1UEBhMC
+    #     ......
+    #     Glli79yh87PRi0vNDlFEoHXNynkvC/c4TiWruZ4haM9BR9EdWr1DBNNu73ui093K
+    #     F9TbdXSWdgMl7E0=
+    #     -----END CERTIFICATE-----
+    #     CERT
     #
     # If you want to work with an IAM user's certificates just use the
     # signing certificate interface on a user:
     #
-    #   user = iam.users['someuser']
-    #   user.signing_certificates.upload(cert_body)
+    #     user = iam.users['someuser']
+    #     user.signing_certificates.upload(cert_body)
     #
     class SigningCertificateCollection
 
       include Collection
 
       # @param [Hash] options
-      # @option options [User] :user (nil) When +:user+ is provided the
+      # @option options [User] :user (nil) When `:user` is provided the
       #   collection will represents the signing certificates belonging only
-      #   to that user.  When +:user+ is omitted the collection will manage
+      #   to that user.  When `:user` is omitted the collection will manage
       #   root credentials on the AWS account (instead those belonging to a
       #   particular user).
       def initialize options = {}
@@ -49,13 +49,13 @@ module AWS
         @user ? super(@user, options) : super(options)
       end
 
-      # @return [User,nil] Returns the user this collection belongs to.  
-      #   Returns +nil+ if the collection represents the root credentials
-      #   for the account.  If the configured credentials belong to an 
+      # @return [User,nil] Returns the user this collection belongs to.
+      #   Returns `nil` if the collection represents the root credentials
+      #   for the account.  If the configured credentials belong to an
       #   IAM user, then that user is the implied owner.
       attr_reader :user
 
-      # @param [String] certificate_body The contents of the signing 
+      # @param [String] certificate_body The contents of the signing
       #   certificate.
       # @return [SigningCertificate] Returns the newly created signing
       #   certificate.
@@ -67,7 +67,7 @@ module AWS
 
         resp = client.upload_signing_certificate(options)
 
-        SigningCertificate.new_from(:upload_signing_certificate, 
+        SigningCertificate.new_from(:upload_signing_certificate,
           resp.certificate, resp.certificate.certificate_id, new_options)
 
       end
@@ -92,14 +92,14 @@ module AWS
 
       # Yields once for each signing certificate.
       #
-      # You can limit the number of certificates yielded using +:limit+.
+      # You can limit the number of certificates yielded using `:limit`.
       #
       # @param [Hash] options
       # @option options [Integer] :limit The maximum number of certificates
       #   to yield.
-      # @option options [Integer] :batch_size The maximum number of 
+      # @option options [Integer] :batch_size The maximum number of
       #   certificates received each service reqeust.
-      # @yieldparam [SigningCertificate] signing_certificate 
+      # @yieldparam [SigningCertificate] signing_certificate
       # @return [nil]
       def each options = {}, &block
         each_options = options.dup
@@ -112,7 +112,7 @@ module AWS
       def each_item response, &block
         response.certificates.each do |item|
 
-          cert = SigningCertificate.new_from(:list_signing_certificates, 
+          cert = SigningCertificate.new_from(:list_signing_certificates,
             item, item.certificate_id, new_options)
 
           yield(cert)

data/lib/aws/iam/user.rb

@@ -14,46 +14,44 @@
 module AWS
   class IAM
 
-    
+
     # Represents an IAM User.  Each AWS account can have many users.  Users
     # can be organized (optionally) into groups.  Users (and groups) can be
     # given policies that affect that they can do.
     #
-    # == Creating A User
-    #
-    #   iam = AWS::IAM.new
+    # ## Creating A User
     #
-    #   user = iam.users.create('johndoe')
-    # 
+    #     iam = AWS::IAM.new
+    #     user = iam.users.create('johndoe')
     #
-    # == Renaming a User
+    # ## Renaming a User
     #
     # You can only edit a user's name and path (both of which will modify
     # the user's ARN).
     #
-    #   user = iam.users['johndoe']
-    #   user.name = 'newname'
+    #     user = iam.users['johndoe']
+    #     user.name = 'newname'
+    #
+    # ## User Path
     #
-    # == User Path
-    # 
     # When you create a user you can assign a path.  Paths must begin and
-    # end with a forward slash (/).  
+    # end with a forward slash (/).
     #
-    #   user = iam.users.create('newuser', :path => '/developers/ruby/')
+    #     user = iam.users.create('newuser', :path => '/developers/ruby/')
     #
     # Paths are a useful tool for organizing/tagging users.  You can later
     # enumerate users by their path prefixes:
     #
-    #   iam.users.each(:path_prefix => '/developers').each do |developer|
-    #     puts developer.name
-    #   end
+    #     iam.users.each(:path_prefix => '/developers').each do |developer|
+    #       puts developer.name
+    #     end
     #
-    # == Login Profile
+    # ## Login Profile
     #
     # A login profile is required for an IAM user to use the AWS Management
     # console (web interface).  See {LoginProfile} for more information.
     #
-    # == Deleting Users
+    # ## Deleting Users
     #
     # In order to delete a user you must first remove it from all of its
     # groups and delete all of its signing certificates.  Once this is done:
@@ -91,8 +89,8 @@ module AWS
       # @attr_reader [String] The user's ARN (Amazon Resource Name).
       attribute :arn
 
-      # @attr [String] The path for this user.  Paths are used to 
-      #   identify which division or part of an organization the user 
+      # @attr [String] The path for this user.  Paths are used to
+      #   identify which division or part of an organization the user
       #   belongs to.
       mutable_attribute :path
 
@@ -129,33 +127,33 @@ module AWS
 
       # Returns a collection that represents all policies for this user.
       #
-      #   user.policies.each do |policy|
-      #     puts policy.name
-      #   end
+      #     user.policies.each do |policy|
+      #       puts policy.name
+      #     end
       #
       # @return [PolicyCollection] Returns a collection that represents
       #   all policies for this user.
       def policies
-        UserPolicyCollection.new(self)  
+        UserPolicyCollection.new(self)
       end
 
       # Returns a collection that represents the signing certificates
       # belonging to this user.
       #
-      #   user.signing_certificates.each do |cert|
-      #     # ...
-      #   end
+      #     user.signing_certificates.each do |cert|
+      #       # ...
+      #     end
       #
       # If you need to access the signing certificates of this AWS account,
       # see {IAM#signing_certificates}.
-      # 
+      #
       # @return [SigningCertificateCollection] Returns a collection that
       #   represents signing certificates for this user.
       def signing_certificates
         SigningCertificateCollection.new(:user => self, :config => config)
       end
 
-      # @return [MFADeviceCollection] Returns a collection that represents 
+      # @return [MFADeviceCollection] Returns a collection that represents
       #   all MFA devices assigned to this user.
       def mfa_devices
         MFADeviceCollection.new(self)
@@ -166,19 +164,18 @@ module AWS
       # Management Console}.  The object returned by this method
       # allows you to set or delete the password.  For example:
       #
-      #   user.login_profile.password = "TheNewPassword"
+      #     user.login_profile.password = "TheNewPassword"
       #
-      # @return [LoginProfile] Returns the login profile for this
-      #   user.
+      # @return [LoginProfile] Returns the login profile for this user.
       def login_profile
         LoginProfile.new(self)
       end
 
       # Returns a collection that represents the access keys for this user.
       #
-      #   user.access_keys.each do |access_key|
-      #     puts access_key.id
-      #   end
+      #     user.access_keys.each do |access_key|
+      #       puts access_key.id
+      #     end
       #
       # @return [AccessKeyCollection] Returns a collection that represents all
       #   access keys for this user.
@@ -186,9 +183,7 @@ module AWS
         AccessKeyCollection.new(:user => self)
       end
 
-      # Returns a collection that includes all of the groups the user
-      # is in.
-      #
+      # Returns a collection that includes all of the groups the user is in.
       # @return [UserGroupCollection]
       def groups
         UserGroupCollection.new(self)

data/lib/aws/iam/user_collection.rb

@@ -14,66 +14,66 @@
 module AWS
   class IAM
 
-    # A collection that provides access to IAM users belonging to this 
+    # A collection that provides access to IAM users belonging to this
     # account.
     #
-    #   iam = AWS::IAM.new
-    #   users = iam.users
+    #     iam = AWS::IAM.new
+    #     users = iam.users
     #
-    # == Creating A User
+    # ## Creating A User
     #
     # To create an IAM user you need only provide a user name.
     #
-    #   user = users.create('username')
+    #     user = users.create('username')
     #
-    # You can also provide an optional +:path+ that can be used to organize
+    # You can also provide an optional `:path` that can be used to organize
     # users.
     #
-    #   user = users.create('johndoe', :path => '/staff/customer_support/')
+    #     user = users.create('johndoe', :path => '/staff/customer_support/')
     #
-    # == Getting a User by Name
+    # ## Getting a User by Name
     #
     # You can get a referene to a user by using array notation:
     #
-    #   user = users['username']
+    #     user = users['username']
     #
-    # == Enumerating Users
+    # ## Enumerating Users
     #
     # A user collection can also be used to enumerate users:
     #
-    #   users.each do |user|
-    #     puts user.name
-    #   end
+    #     users.each do |user|
+    #       puts user.name
+    #     end
     #
-    # == Path Prefixes
+    # ## Path Prefixes
     #
     # You can also find/enumerate users who's path begins with a given prefix:
     #
-    #   users.each(:path_prefix => '/staff/developers/ruby').each do |ruby_dev|
-    #     puts "#{ruby_dev.name} is awesome!"
-    #   end
+    #     users.each(:path_prefix => '/staff/developers/ruby').each do |ruby_dev|
+    #       puts "#{ruby_dev.name} is awesome!"
+    #     end
     #
     class UserCollection
 
       include Collection::WithPrefix
 
       # @param [String] name Name of the user to create.
-      # @option options [String] :path ('/') The path for the user name. 
-      #   For more information about paths, see 
-      #   {Identifiers for IAM Entities}[http://docs.amazonwebservices.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html]
+      # @option options [String] :path ('/') The path for the user name.
+      #   For more information about paths, see
+      #   [Identifiers for IAM Entities](http://docs.amazonwebservices.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html)
       # @return [User] Returns the newly created user.
       def create name, options = {}
         create_opts = {}
         create_opts[:user_name] = name
         create_opts[:path] = options[:path] if options[:path]
         resp = client.create_user(create_opts)
-        User.new_from(:create_user, resp.user, 
+        User.new_from(:create_user, resp.user,
           resp.user.user_name, :config => config)
       end
 
       # Returns a reference to the user with the given name:
       #
-      #   user = iam.users['username']
+      #     user = iam.users['username']
       #
       # @param [String] name Name of the user to return a reference for.
       # @return [User] Returns a reference to the named user.
@@ -83,8 +83,8 @@ module AWS
 
       # Yields once for each user.
       #
-      # You can limit the number of users yielded using +:limit+ and
-      # +:path_prefix+.
+      # You can limit the number of users yielded using `:limit` and
+      # `:path_prefix`.
       #
       # @param [Hash] options
       #
@@ -104,9 +104,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).
       #
-      #   users.enumerator(:path_prefix => '/admin').collect(&:name)
+      #     users.enumerator(:path_prefix => '/admin').collect(&:name)
       #
       # @param (see #each)
       # @option (see #each)
@@ -120,7 +120,7 @@ module AWS
       def each_item response, &block
         response.users.each do |item|
 
-          user = User.new_from(:list_users, item, 
+          user = User.new_from(:list_users, item,
             item.user_name, :config => config)
 
           yield(user)

data/lib/aws/iam/user_group_collection.rb

@@ -17,9 +17,9 @@ module AWS
     # A collection that provides access to IAM groups to which a
     # particular user belongs.
     #
-    #   user = AWS::IAM.new.users.first
-    #   groups = user.groups
-    #   groups.each { |g| puts g.name }
+    #     user = AWS::IAM.new.users.first
+    #     groups = user.groups
+    #     groups.each { |g| puts g.name }
     #
     class UserGroupCollection
 

data/lib/aws/iam/user_policy_collection.rb

@@ -18,12 +18,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
-    #  user.policies["ReadOnly"] = policy
-    #  user.policies.has_key?("ReadOnly")  # => true
+    #     # add or replace a policy named "ReadOnly"
+    #     policy = AWS::IAM::Policy.new do |p|
+    #       # ...
+    #     end
+    #     user.policies["ReadOnly"] = policy
+    #     user.policies.has_key?("ReadOnly")  # => true
     #
     # All of the methods for this class are defined in the
     # {PolicyCollection} module.

data/lib/aws/iam/virtual_mfa_device.rb

@@ -16,14 +16,14 @@ require 'base64'
 module AWS
   class IAM
 
-    # @attr_reader [String] base_32_string_seed The Base32 seed defined as 
-    #   specified in RFC3548.  Only accessible on newly created 
+    # @attr_reader [String] base_32_string_seed The Base32 seed defined as
+    #   specified in RFC3548.  Only accessible on newly created
     #   devices. This value is Base64-encoded.
-    # 
-    # @attr_reader [Blob] qr_code_png A QR code PNG image that encodes 
-    #   otpauth://totp/$virtualMFADeviceName@$AccountName? secret=$Base32String 
-    #   where $virtualMFADeviceName is one of the create call arguments, 
-    #   AccountName is the user name if set (accountId otherwise), and 
+    #
+    # @attr_reader [Blob] qr_code_png A QR code PNG image that encodes
+    #   otpauth://totp/$virtualMFADeviceName@$AccountName? secret=$Base32String
+    #   where $virtualMFADeviceName is one of the create call arguments,
+    #   AccountName is the user name if set (accountId otherwise), and
     #   Base32String is the seed in Base32 format.  Only accessible on newly
     #   created devices. This value is Base64-encoded.
     #
@@ -61,13 +61,13 @@ module AWS
         end
       end
 
-      # Enables the MFA device and associates it with the specified user. 
-      # When enabled, the MFA device is required for every subsequent login 
+      # Enables the MFA device and associates it with the specified user.
+      # When enabled, the MFA device is required for every subsequent login
       # by the user name associated with the device.
       # @param [User,String] user The user (or user name string) you want
       #   to enable this device for.
       # @param [String] code1 An authentication code emitted by the device.
-      # @param [String] code2 A subsequent authentication code emitted by 
+      # @param [String] code2 A subsequent authentication code emitted by
       #   the device.
       def enable user, code1, code2
 
@@ -89,7 +89,7 @@ module AWS
         !!enable_date
       end
 
-      # Deactivates the MFA device and removes it from association with 
+      # Deactivates the MFA device and removes it from association with
       # the user for which it was originally enabled.
       # @return [nil]
       def deactivate
@@ -110,7 +110,7 @@ module AWS
 
       populates_from :create_virtual_mfa_device do |resp|
         if resp.virtual_mfa_device.serial_number == serial_number
-          resp.virtual_mfa_device 
+          resp.virtual_mfa_device
         end
       end