aws-sdk-iam 1.0.0.rc1 → 1.0.0.rc2

data/lib/aws-sdk-iam/role.rb

@@ -1,310 +1,308 @@
 # WARNING ABOUT GENERATED CODE
 #
-# This file is generated. See the contributing for info on making contributions:
+# This file is generated. See the contributing guide for more information:
 # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
 #
 # WARNING ABOUT GENERATED CODE
 
-module Aws
-  module IAM
-    class Role
+module Aws::IAM
+  class Role
 
-      extend Aws::Deprecations
+    extend Aws::Deprecations
 
-      # @overload def initialize(name, options = {})
-      #   @param [String] name
-      #   @option options [Client] :client
-      # @overload def initialize(options = {})
-      #   @option options [required, String] :name
-      #   @option options [Client] :client
-      def initialize(*args)
-        options = Hash === args.last ? args.pop.dup : {}
-        @name = extract_name(args, options)
-        @data = options.delete(:data)
-        @client = options.delete(:client) || Client.new(options)
-      end
+    # @overload def initialize(name, options = {})
+    #   @param [String] name
+    #   @option options [Client] :client
+    # @overload def initialize(options = {})
+    #   @option options [required, String] :name
+    #   @option options [Client] :client
+    def initialize(*args)
+      options = Hash === args.last ? args.pop.dup : {}
+      @name = extract_name(args, options)
+      @data = options.delete(:data)
+      @client = options.delete(:client) || Client.new(options)
+    end
 
-      # @!group Read-Only Attributes
+    # @!group Read-Only Attributes
 
-      # @return [String]
-      def name
-        @name
-      end
-      alias :role_name :name
+    # @return [String]
+    def name
+      @name
+    end
+    alias :role_name :name
 
-      # The path to the role. For more information about paths, see [IAM
-      # Identifiers][1] in the *Using IAM* guide.
-      #
-      #
-      #
-      # [1]: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html
-      # @return [String]
-      def path
-        data.path
-      end
+    # The path to the role. For more information about paths, see [IAM
+    # Identifiers][1] in the *Using IAM* guide.
+    #
+    #
+    #
+    # [1]: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html
+    # @return [String]
+    def path
+      data.path
+    end
 
-      # The stable and unique string identifying the role. For more
-      # information about IDs, see [IAM Identifiers][1] in the *Using IAM*
-      # guide.
-      #
-      #
-      #
-      # [1]: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html
-      # @return [String]
-      def role_id
-        data.role_id
-      end
+    # The stable and unique string identifying the role. For more
+    # information about IDs, see [IAM Identifiers][1] in the *Using IAM*
+    # guide.
+    #
+    #
+    #
+    # [1]: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html
+    # @return [String]
+    def role_id
+      data.role_id
+    end
 
-      # The Amazon Resource Name (ARN) specifying the role. For more
-      # information about ARNs and how to use them in policies, see [IAM
-      # Identifiers][1] in the *Using IAM* guide.
-      #
-      #
-      #
-      # [1]: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html
-      # @return [String]
-      def arn
-        data.arn
-      end
+    # The Amazon Resource Name (ARN) specifying the role. For more
+    # information about ARNs and how to use them in policies, see [IAM
+    # Identifiers][1] in the *Using IAM* guide.
+    #
+    #
+    #
+    # [1]: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html
+    # @return [String]
+    def arn
+      data.arn
+    end
 
-      # The date and time, in [ISO 8601 date-time format][1], when the role
-      # was created.
-      #
-      #
-      #
-      # [1]: http://www.iso.org/iso/iso8601
-      # @return [Time]
-      def create_date
-        data.create_date
-      end
+    # The date and time, in [ISO 8601 date-time format][1], when the role
+    # was created.
+    #
+    #
+    #
+    # [1]: http://www.iso.org/iso/iso8601
+    # @return [Time]
+    def create_date
+      data.create_date
+    end
 
-      # The policy that grants an entity permission to assume the role.
-      # @return [String]
-      def assume_role_policy_document
-        data.assume_role_policy_document
-      end
+    # The policy that grants an entity permission to assume the role.
+    # @return [String]
+    def assume_role_policy_document
+      data.assume_role_policy_document
+    end
 
-      # @!endgroup
+    # @!endgroup
 
-      # @return [Client]
-      def client
-        @client
-      end
+    # @return [Client]
+    def client
+      @client
+    end
 
-      # Loads, or reloads {#data} for the current {Role}.
-      # Returns `self` making it possible to chain methods.
-      #
-      #     role.reload.data
-      #
-      # @return [self]
-      def load
-        resp = @client.get_role(role_name: @name)
-        @data = resp.role
-        self
-      end
-      alias :reload :load
+    # Loads, or reloads {#data} for the current {Role}.
+    # Returns `self` making it possible to chain methods.
+    #
+    #     role.reload.data
+    #
+    # @return [self]
+    def load
+      resp = @client.get_role(role_name: @name)
+      @data = resp.role
+      self
+    end
+    alias :reload :load
 
-      # @return [Types::Role]
-      #   Returns the data for this {Role}. Calls
-      #   {Client#get_role} if {#data_loaded?} is `false`.
-      def data
-        load unless @data
-        @data
-      end
+    # @return [Types::Role]
+    #   Returns the data for this {Role}. Calls
+    #   {Client#get_role} if {#data_loaded?} is `false`.
+    def data
+      load unless @data
+      @data
+    end
 
-      # @return [Boolean]
-      #   Returns `true` if this resource is loaded.  Accessing attributes or
-      #   {#data} on an unloaded resource will trigger a call to {#load}.
-      def data_loaded?
-        !!@data
-      end
+    # @return [Boolean]
+    #   Returns `true` if this resource is loaded.  Accessing attributes or
+    #   {#data} on an unloaded resource will trigger a call to {#load}.
+    def data_loaded?
+      !!@data
+    end
 
-      # @!group Actions
+    # @!group Actions
 
-      # @example Request syntax with placeholder values
-      #
-      #   role.attach_policy({
-      #     policy_arn: "arnType", # required
-      #   })
-      # @param [Hash] options ({})
-      # @option options [required, String] :policy_arn
-      #   The Amazon Resource Name (ARN) of the IAM policy you want to attach.
-      #
-      #   For more information about ARNs, see [Amazon Resource Names (ARNs) and
-      #   AWS Service Namespaces][1] in the *AWS General Reference*.
-      #
-      #
-      #
-      #   [1]: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
-      # @return [EmptyStructure]
-      def attach_policy(options = {})
-        options = options.merge(role_name: @name)
-        resp = @client.attach_role_policy(options)
-        resp.data
-      end
+    # @example Request syntax with placeholder values
+    #
+    #   role.attach_policy({
+    #     policy_arn: "arnType", # required
+    #   })
+    # @param [Hash] options ({})
+    # @option options [required, String] :policy_arn
+    #   The Amazon Resource Name (ARN) of the IAM policy you want to attach.
+    #
+    #   For more information about ARNs, see [Amazon Resource Names (ARNs) and
+    #   AWS Service Namespaces][1] in the *AWS General Reference*.
+    #
+    #
+    #
+    #   [1]: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
+    # @return [EmptyStructure]
+    def attach_policy(options = {})
+      options = options.merge(role_name: @name)
+      resp = @client.attach_role_policy(options)
+      resp.data
+    end
 
-      # @example Request syntax with placeholder values
-      #
-      #   role.delete()
-      # @param [Hash] options ({})
-      # @return [EmptyStructure]
-      def delete(options = {})
-        options = options.merge(role_name: @name)
-        resp = @client.delete_role(options)
-        resp.data
-      end
+    # @example Request syntax with placeholder values
+    #
+    #   role.delete()
+    # @param [Hash] options ({})
+    # @return [EmptyStructure]
+    def delete(options = {})
+      options = options.merge(role_name: @name)
+      resp = @client.delete_role(options)
+      resp.data
+    end
 
-      # @example Request syntax with placeholder values
-      #
-      #   role.detach_policy({
-      #     policy_arn: "arnType", # required
-      #   })
-      # @param [Hash] options ({})
-      # @option options [required, String] :policy_arn
-      #   The Amazon Resource Name (ARN) of the IAM policy you want to detach.
-      #
-      #   For more information about ARNs, see [Amazon Resource Names (ARNs) and
-      #   AWS Service Namespaces][1] in the *AWS General Reference*.
-      #
-      #
-      #
-      #   [1]: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
-      # @return [EmptyStructure]
-      def detach_policy(options = {})
-        options = options.merge(role_name: @name)
-        resp = @client.detach_role_policy(options)
-        resp.data
-      end
+    # @example Request syntax with placeholder values
+    #
+    #   role.detach_policy({
+    #     policy_arn: "arnType", # required
+    #   })
+    # @param [Hash] options ({})
+    # @option options [required, String] :policy_arn
+    #   The Amazon Resource Name (ARN) of the IAM policy you want to detach.
+    #
+    #   For more information about ARNs, see [Amazon Resource Names (ARNs) and
+    #   AWS Service Namespaces][1] in the *AWS General Reference*.
+    #
+    #
+    #
+    #   [1]: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
+    # @return [EmptyStructure]
+    def detach_policy(options = {})
+      options = options.merge(role_name: @name)
+      resp = @client.detach_role_policy(options)
+      resp.data
+    end
 
-      # @!group Associations
+    # @!group Associations
 
-      # @return [AssumeRolePolicy]
-      def assume_role_policy
-        AssumeRolePolicy.new(
-          role_name: @name,
-          client: @client
-        )
-      end
+    # @return [AssumeRolePolicy]
+    def assume_role_policy
+      AssumeRolePolicy.new(
+        role_name: @name,
+        client: @client
+      )
+    end
 
-      # @example Request syntax with placeholder values
-      #
-      #   attachedpolicies = role.attached_policies({
-      #     path_prefix: "policyPathType",
-      #   })
-      # @param [Hash] options ({})
-      # @option options [String] :path_prefix
-      #   The path prefix for filtering the results. This parameter is optional.
-      #   If it is not included, it defaults to a slash (/), listing all
-      #   policies.
-      #
-      #   The [regex pattern][1] for this parameter is a string of characters
-      #   consisting of either a forward slash (/) by itself or a string that
-      #   must begin and end with forward slashes, containing any ASCII
-      #   character from the ! (\\u0021) thru the DEL character (\\u007F),
-      #   including most punctuation characters, digits, and upper and
-      #   lowercased letters.
-      #
-      #
-      #
-      #   [1]: http://wikipedia.org/wiki/regex
-      # @return [Policy::Collection]
-      def attached_policies(options = {})
-        batches = Enumerator.new do |y|
-          options = options.merge(role_name: @name)
-          resp = @client.list_attached_role_policies(options)
-          resp.each_page do |page|
-            batch = []
-            page.data.attached_policies.each do |a|
-              batch << Policy.new(
-                arn: a.policy_arn,
-                client: @client
-              )
-            end
-            y.yield(batch)
+    # @example Request syntax with placeholder values
+    #
+    #   attached_policies = role.attached_policies({
+    #     path_prefix: "policyPathType",
+    #   })
+    # @param [Hash] options ({})
+    # @option options [String] :path_prefix
+    #   The path prefix for filtering the results. This parameter is optional.
+    #   If it is not included, it defaults to a slash (/), listing all
+    #   policies.
+    #
+    #   This paramater allows (per its [regex pattern][1]) a string of
+    #   characters consisting of either a forward slash (/) by itself or a
+    #   string that must begin and end with forward slashes, containing any
+    #   ASCII character from the ! (\\u0021) thru the DEL character (\\u007F),
+    #   including most punctuation characters, digits, and upper and
+    #   lowercased letters.
+    #
+    #
+    #
+    #   [1]: http://wikipedia.org/wiki/regex
+    # @return [Policy::Collection]
+    def attached_policies(options = {})
+      batches = Enumerator.new do |y|
+        options = options.merge(role_name: @name)
+        resp = @client.list_attached_role_policies(options)
+        resp.each_page do |page|
+          batch = []
+          page.data.attached_policies.each do |a|
+            batch << Policy.new(
+              arn: a.policy_arn,
+              client: @client
+            )
           end
+          y.yield(batch)
         end
-        Policy::Collection.new(batches)
       end
+      Policy::Collection.new(batches)
+    end
 
-      # @example Request syntax with placeholder values
-      #
-      #   instanceprofiles = role.instance_profiles()
-      # @param [Hash] options ({})
-      # @return [InstanceProfile::Collection]
-      def instance_profiles(options = {})
-        batches = Enumerator.new do |y|
-          options = options.merge(role_name: @name)
-          resp = @client.list_instance_profiles_for_role(options)
-          resp.each_page do |page|
-            batch = []
-            page.data.instance_profiles.each do |i|
-              batch << InstanceProfile.new(
-                name: i.instance_profile_name,
-                data: i,
-                client: @client
-              )
-            end
-            y.yield(batch)
+    # @example Request syntax with placeholder values
+    #
+    #   role.instance_profiles()
+    # @param [Hash] options ({})
+    # @return [InstanceProfile::Collection]
+    def instance_profiles(options = {})
+      batches = Enumerator.new do |y|
+        options = options.merge(role_name: @name)
+        resp = @client.list_instance_profiles_for_role(options)
+        resp.each_page do |page|
+          batch = []
+          page.data.instance_profiles.each do |i|
+            batch << InstanceProfile.new(
+              name: i.instance_profile_name,
+              data: i,
+              client: @client
+            )
           end
+          y.yield(batch)
         end
-        InstanceProfile::Collection.new(batches)
       end
+      InstanceProfile::Collection.new(batches)
+    end
 
-      # @example Request syntax with placeholder values
-      #
-      #   policies = role.policies()
-      # @param [Hash] options ({})
-      # @return [RolePolicy::Collection]
-      def policies(options = {})
-        batches = Enumerator.new do |y|
-          options = options.merge(role_name: @name)
-          resp = @client.list_role_policies(options)
-          resp.each_page do |page|
-            batch = []
-            page.data.policy_names.each do |p|
-              batch << RolePolicy.new(
-                role_name: @name,
-                name: p,
-                client: @client
-              )
-            end
-            y.yield(batch)
+    # @example Request syntax with placeholder values
+    #
+    #   role.policies()
+    # @param [Hash] options ({})
+    # @return [RolePolicy::Collection]
+    def policies(options = {})
+      batches = Enumerator.new do |y|
+        options = options.merge(role_name: @name)
+        resp = @client.list_role_policies(options)
+        resp.each_page do |page|
+          batch = []
+          page.data.policy_names.each do |p|
+            batch << RolePolicy.new(
+              role_name: @name,
+              name: p,
+              client: @client
+            )
           end
+          y.yield(batch)
         end
-        RolePolicy::Collection.new(batches)
       end
+      RolePolicy::Collection.new(batches)
+    end
 
-      # @param [String] name
-      # @return [RolePolicy]
-      def policy(name)
-        RolePolicy.new(
-          role_name: @name,
-          name: name,
-          client: @client
-        )
-      end
+    # @param [String] name
+    # @return [RolePolicy]
+    def policy(name)
+      RolePolicy.new(
+        role_name: @name,
+        name: name,
+        client: @client
+      )
+    end
 
-      # @deprecated
-      # @api private
-      def identifiers
-        { name: @name }
-      end
-      deprecated(:identifiers)
+    # @deprecated
+    # @api private
+    def identifiers
+      { name: @name }
+    end
+    deprecated(:identifiers)
 
-      private
+    private
 
-      def extract_name(args, options)
-        value = args[0] || options.delete(:name)
-        case value
-        when String then value
-        when nil then raise ArgumentError, "missing required option :name"
-        else
-          msg = "expected :name to be a String, got #{value.class}"
-          raise ArgumentError, msg
-        end
+    def extract_name(args, options)
+      value = args[0] || options.delete(:name)
+      case value
+      when String then value
+      when nil then raise ArgumentError, "missing required option :name"
+      else
+        msg = "expected :name to be a String, got #{value.class}"
+        raise ArgumentError, msg
       end
-
-      class Collection < Aws::Resources::Collection; end
     end
+
+    class Collection < Aws::Resources::Collection; end
   end
 end