Class: Aws::IAM::User
- Inherits:
-
Object
- Object
- Aws::IAM::User
- Defined in:
- gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
-
#arn ⇒ String
The Amazon Resource Name (ARN) that identifies the user.
-
#create_date ⇒ Time
The date and time, in [ISO 8601 date-time format][1], when the user was created.
-
#name ⇒ String
(also: #user_name)
-
#password_last_used ⇒ Time
The date and time, in [ISO 8601 date-time format][1], when the user's password was last used to sign in to an Amazon Web Services website.
-
#path ⇒ String
The path to the user.
-
#permissions_boundary ⇒ Types::AttachedPermissionsBoundary
For more information about permissions boundaries, see [Permissions boundaries for IAM identities ][1] in the IAM User Guide.
-
#tags ⇒ Array<Types::Tag>
A list of tags that are associated with the user.
-
#user_id ⇒ String
The stable and unique string identifying the user.
Actions collapse
-
#add_group(options = {}) ⇒ EmptyStructure
-
#attach_policy(options = {}) ⇒ EmptyStructure
-
#create(options = {}) ⇒ User
-
#create_access_key_pair(options = {}) ⇒ AccessKeyPair
-
#create_login_profile(options = {}) ⇒ LoginProfile
-
#create_policy(options = {}) ⇒ UserPolicy
-
#delete(options = {}) ⇒ EmptyStructure
-
#detach_policy(options = {}) ⇒ EmptyStructure
-
#enable_mfa(options = {}) ⇒ MfaDevice
-
#remove_group(options = {}) ⇒ EmptyStructure
-
#update(options = {}) ⇒ User
Associations collapse
-
#access_key(id) ⇒ AccessKey
-
#access_keys(options = {}) ⇒ AccessKey::Collection
-
#attached_policies(options = {}) ⇒ Policy::Collection
-
#groups(options = {}) ⇒ Group::Collection
-
#login_profile ⇒ LoginProfile
-
#mfa_device(serial_number) ⇒ MfaDevice
-
#mfa_devices(options = {}) ⇒ MfaDevice::Collection
-
#policies(options = {}) ⇒ UserPolicy::Collection
-
#policy(name) ⇒ UserPolicy
-
#signing_certificate(id) ⇒ SigningCertificate
-
#signing_certificates(options = {}) ⇒ SigningCertificate::Collection
Instance Method Summary collapse
-
#client ⇒ Client
-
#data ⇒ Types::User
Returns the data for this User.
-
#data_loaded? ⇒ Boolean
Returns
trueif this resource is loaded. -
#exists?(options = {}) ⇒ Boolean
Returns
trueif the User exists. -
#initialize(*args) ⇒ User
constructor
A new instance of User.
- #load ⇒ self (also: #reload)
-
#wait_until(options = {}) {|resource| ... } ⇒ Resource
deprecated
Deprecated.
Use [Aws::IAM::Client] #wait_until instead
-
#wait_until_exists(options = {}, &block) ⇒ User
Constructor Details
#initialize(name, options = {}) ⇒ User #initialize(options = {}) ⇒ User
Returns a new instance of User.
22 23 24 25 26 27 28 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 22 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @name = extract_name(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() @waiter_block_warned = false end |
Instance Method Details
#access_key(id) ⇒ AccessKey
736 737 738 739 740 741 742 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 736 def access_key(id) AccessKey.new( user_name: @name, id: id, client: @client ) end |
#access_keys(options = {}) ⇒ AccessKey::Collection
749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 749 def access_keys( = {}) batches = Enumerator.new do |y| = .merge(user_name: @name) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.list_access_keys() end resp.each_page do |page| batch = [] page.data..each do |a| batch << AccessKey.new( user_name: @name, id: a.access_key_id, data: a, client: @client ) end y.yield(batch) end end AccessKey::Collection.new(batches) end |
#add_group(options = {}) ⇒ EmptyStructure
331 332 333 334 335 336 337 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 331 def add_group( = {}) = .merge(user_name: @name) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.add_user_to_group() end resp.data end |
#arn ⇒ String
The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide.
72 73 74 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 72 def arn data[:arn] end |
#attach_policy(options = {}) ⇒ EmptyStructure
355 356 357 358 359 360 361 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 355 def attach_policy( = {}) = .merge(user_name: @name) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.attach_user_policy() end resp.data end |
#attached_policies(options = {}) ⇒ Policy::Collection
793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 793 def attached_policies( = {}) batches = Enumerator.new do |y| = .merge(user_name: @name) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.list_attached_user_policies() end 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 end Policy::Collection.new(batches) end |
#client ⇒ Client
145 146 147 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 145 def client @client end |
#create(options = {}) ⇒ User
427 428 429 430 431 432 433 434 435 436 437 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 427 def create( = {}) = .merge(user_name: @name) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.create_user() end User.new( name: [:user_name], data: resp.data.user, client: @client ) end |
#create_access_key_pair(options = {}) ⇒ AccessKeyPair
444 445 446 447 448 449 450 451 452 453 454 455 456 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 444 def create_access_key_pair( = {}) = .merge(user_name: @name) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.create_access_key() end AccessKeyPair.new( user_name: @name, id: resp.data.access_key.access_key_id, secret: resp.data.access_key.secret_access_key, data: resp.data.access_key, client: @client ) end |
#create_date ⇒ Time
The date and time, in ISO 8601 date-time format, when the user was created.
83 84 85 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 83 def create_date data[:create_date] end |
#create_login_profile(options = {}) ⇒ LoginProfile
500 501 502 503 504 505 506 507 508 509 510 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 500 def create_login_profile( = {}) = .merge(user_name: @name) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.create_login_profile() end LoginProfile.new( user_name: resp.data.login_profile.user_name, data: resp.data.login_profile, client: @client ) end |
#create_policy(options = {}) ⇒ UserPolicy
554 555 556 557 558 559 560 561 562 563 564 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 554 def create_policy( = {}) = .merge(user_name: @name) Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.put_user_policy() end UserPolicy.new( user_name: @name, name: [:policy_name], client: @client ) end |
#data ⇒ Types::User
Returns the data for this Aws::IAM::User. Calls
Client#get_user if #data_loaded? is false.
167 168 169 170 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 167 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
175 176 177 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 175 def data_loaded? !!@data end |
#delete(options = {}) ⇒ EmptyStructure
571 572 573 574 575 576 577 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 571 def delete( = {}) = .merge(user_name: @name) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.delete_user() end resp.data end |
#detach_policy(options = {}) ⇒ EmptyStructure
595 596 597 598 599 600 601 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 595 def detach_policy( = {}) = .merge(user_name: @name) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.detach_user_policy() end resp.data end |
#enable_mfa(options = {}) ⇒ MfaDevice
654 655 656 657 658 659 660 661 662 663 664 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 654 def enable_mfa( = {}) = .merge(user_name: @name) Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.enable_mfa_device() end MfaDevice.new( user_name: @name, serial_number: [:serial_number], client: @client ) end |
#exists?(options = {}) ⇒ Boolean
Returns true if the User exists.
182 183 184 185 186 187 188 189 190 191 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 182 def exists?( = {}) begin wait_until_exists(.merge(max_attempts: 1)) true rescue Aws::Waiters::Errors::UnexpectedError => e raise e.error rescue Aws::Waiters::Errors::WaiterFailed false end end |
#groups(options = {}) ⇒ Group::Collection
818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 818 def groups( = {}) batches = Enumerator.new do |y| = .merge(user_name: @name) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.list_groups_for_user() end resp.each_page do |page| batch = [] page.data.groups.each do |g| batch << Group.new( name: g.group_name, data: g, client: @client ) end y.yield(batch) end end Group::Collection.new(batches) end |
#load ⇒ self Also known as: reload
Loads, or reloads #data for the current Aws::IAM::User.
Returns self making it possible to chain methods.
user.reload.data
155 156 157 158 159 160 161 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 155 def load resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.get_user(user_name: @name) end @data = resp.user self end |
#login_profile ⇒ LoginProfile
840 841 842 843 844 845 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 840 def login_profile LoginProfile.new( user_name: @name, client: @client ) end |
#mfa_device(serial_number) ⇒ MfaDevice
849 850 851 852 853 854 855 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 849 def mfa_device(serial_number) MfaDevice.new( user_name: @name, serial_number: serial_number, client: @client ) end |
#mfa_devices(options = {}) ⇒ MfaDevice::Collection
862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 862 def mfa_devices( = {}) batches = Enumerator.new do |y| = .merge(user_name: @name) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.list_mfa_devices() end resp.each_page do |page| batch = [] page.data.mfa_devices.each do |m| batch << MfaDevice.new( user_name: @name, serial_number: m.serial_number, data: m, client: @client ) end y.yield(batch) end end MfaDevice::Collection.new(batches) end |
#name ⇒ String Also known as: user_name
33 34 35 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 33 def name @name end |
#password_last_used ⇒ Time
The date and time, in ISO 8601 date-time format, when the user's password was last used to sign in to an Amazon Web Services website. For a list of Amazon Web Services websites that capture a user's last sign-in time, see the Credential reports topic in the IAM User Guide. If a password is used more than once in a five-minute span, only the first use is returned in this field. If the field is null (no value), then it indicates that they never signed in with a password. This can be because:
The user never had a password.
A password exists but has not been used since IAM started tracking this information on October 20, 2014.
A null value does not mean that the user never had a password. Also, if the user does not currently have a password but had one in the past, then this field contains the date and time the most recent password was used.
This value is returned only in the GetUser and ListUsers operations.
116 117 118 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 116 def password_last_used data[:password_last_used] end |
#path ⇒ String
The path to the user. For more information about paths, see IAM identifiers in the IAM User Guide.
The ARN of the policy used to set the permissions boundary for the user.
48 49 50 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 48 def path data[:path] end |
#permissions_boundary ⇒ Types::AttachedPermissionsBoundary
For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.
127 128 129 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 127 def data[:permissions_boundary] end |
#policies(options = {}) ⇒ UserPolicy::Collection
889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 889 def policies( = {}) batches = Enumerator.new do |y| = .merge(user_name: @name) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.list_user_policies() end resp.each_page do |page| batch = [] page.data.policy_names.each do |p| batch << UserPolicy.new( user_name: @name, name: p, client: @client ) end y.yield(batch) end end UserPolicy::Collection.new(batches) end |
#policy(name) ⇒ UserPolicy
912 913 914 915 916 917 918 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 912 def policy(name) UserPolicy.new( user_name: @name, name: name, client: @client ) end |
#remove_group(options = {}) ⇒ EmptyStructure
684 685 686 687 688 689 690 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 684 def remove_group( = {}) = .merge(user_name: @name) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.remove_user_from_group() end resp.data end |
#signing_certificate(id) ⇒ SigningCertificate
922 923 924 925 926 927 928 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 922 def signing_certificate(id) SigningCertificate.new( user_name: @name, id: id, client: @client ) end |
#signing_certificates(options = {}) ⇒ SigningCertificate::Collection
935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 935 def signing_certificates( = {}) batches = Enumerator.new do |y| = .merge(user_name: @name) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.list_signing_certificates() end resp.each_page do |page| batch = [] page.data.certificates.each do |c| batch << SigningCertificate.new( user_name: @name, id: c.certificate_id, data: c, client: @client ) end y.yield(batch) end end SigningCertificate::Collection.new(batches) end |
#tags ⇒ Array<Types::Tag>
A list of tags that are associated with the user. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
138 139 140 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 138 def data[:tags] end |
#update(options = {}) ⇒ User
721 722 723 724 725 726 727 728 729 730 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 721 def update( = {}) = .merge(user_name: @name) Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.update_user() end User.new( name: [:new_user_name], client: @client ) end |
#user_id ⇒ String
The stable and unique string identifying the user. For more information about IDs, see IAM identifiers in the IAM User Guide.
60 61 62 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 60 def user_id data[:user_id] end |
#wait_until(options = {}) {|resource| ... } ⇒ Resource
Use [Aws::IAM::Client] #wait_until instead
The waiting operation is performed on a copy. The original resource remains unchanged.
Waiter polls an API operation until a resource enters a desired state.
Basic Usage
Waiter will polls until it is successful, it fails by entering a terminal state, or until a maximum number of attempts are made.
# polls in a loop until condition is true
resource.wait_until() {|resource| condition}
Example
instance.wait_until(max_attempts:10, delay:5) do |instance|
instance.state.name == 'running'
end
Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. The waiting condition is set by passing a block to #wait_until:
# poll for ~25 seconds
resource.wait_until(max_attempts:5,delay:5) {|resource|...}
Callbacks
You can be notified before each polling attempt and before each
delay. If you throw :success or :failure from these callbacks,
it will terminate the waiter.
started_at = Time.now
# poll for 1 hour, instead of a number of attempts
proc = Proc.new do |attempts, response|
throw :failure if Time.now - started_at > 3600
end
# disable max attempts
instance.wait_until(before_wait:proc, max_attempts:nil) {...}
Handling Errors
When a waiter is successful, it returns the Resource. When a waiter fails, it raises an error.
begin
resource.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
attempts attempt in seconds invoked before each attempt invoked before each wait
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 292 def wait_until( = {}, &block) self_copy = self.dup attempts = 0 [:max_attempts] = 10 unless .key?(:max_attempts) [:delay] ||= 10 [:poller] = Proc.new do attempts += 1 if block.call(self_copy) [:success, self_copy] else self_copy.reload unless attempts == [:max_attempts] :retry end end Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do Aws::Waiters::Waiter.new().wait({}) end end |
#wait_until_exists(options = {}, &block) ⇒ User
199 200 201 202 203 204 205 206 207 208 209 210 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/user.rb', line 199 def wait_until_exists( = {}, &block) , params = () waiter = Waiters::UserExists.new() yield_waiter_and_warn(waiter, &block) if block_given? Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do waiter.wait(params.merge(user_name: @name)) end User.new({ name: @name, client: @client }) end |