File: account_alias_collection.rb

package info (click to toggle)
ruby-aws-sdk 1.67.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 6,840 kB
  • sloc: ruby: 28,436; makefile: 7
file content (79 lines) | stat: -rw-r--r-- 2,501 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
#     http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.

module AWS
  class IAM

    # @api private
    #
    # Currently IAM exposes the account alias in a collection, as if you
    # could create/manage multiple aliases for a single account.  However,
    # creating a 2nd alias replaces the first, it does not add an additional
    # alias.
    #
    # Because the API is modeled as a collection this class could be used
    # to work with it, but instead we consume this by the IAM class for
    # the following methods:
    #
    #   * create_account_alias
    #   * account_alias
    #   * remove_account_alias
    #
    # If IAM allows accounts to have multiple aliases, then those previous
    # 3 methods will be deprecated and this interface will be exposed.
    class AccountAliasCollection

      include Collection

      # Creates an AWS account alias.
      #
      #     iam.account_aliases.create('myaccountalias')
      #
      # For information about account alias restrictions and usage,
      # see http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?AccountAlias.html.
      #
      # @param [String] account_alias
      # @return [String] Returns the account_alias string that was passed.
      def create account_alias
        client.create_account_alias(:account_alias => account_alias)
        account_alias
      end

      # Delete an AWS account alias.
      #
      #     iam.account_aliases.delete('myaccountalias')
      #
      # @param [String] account_alias The account alias to delete.
      # @return [nil]
      def delete account_alias
        client.delete_account_alias(:account_alias => account_alias)
        nil
      end

      # @api private
      protected
      def request_method
        :list_account_aliases
      end

      # @api private
      protected
      def each_item response, &block
        response.data[:account_aliases].each do |account_alias|
          yield(account_alias)
        end
      end

    end
  end
end