Class: Aws::IAM::Resource
- Inherits:
-
Object
- Object
- Aws::IAM::Resource
- Defined in:
- gems/aws-sdk-iam/lib/aws-sdk-iam/resource.rb,
gems/aws-sdk-iam/lib/aws-sdk-iam/customizations/resource.rb
Overview
This class provides a resource oriented interface for IAM. To create a resource object:
resource = Aws::IAM::Resource.new(region: 'us-west-2')
You can supply a client object with custom configuration that will be used for all resource operations.
If you do not pass :client, a default client will be constructed.
client = Aws::IAM::Client.new(region: 'us-west-2')
resource = Aws::IAM::Resource.new(client: client)
Actions collapse
-
#change_password(options = {}) ⇒ EmptyStructure
-
#create_account_alias(options = {}) ⇒ EmptyStructure
-
#create_account_password_policy(options = {}) ⇒ AccountPasswordPolicy
-
#create_group(options = {}) ⇒ Group
-
#create_instance_profile(options = {}) ⇒ InstanceProfile
-
#create_policy(options = {}) ⇒ Policy
-
#create_role(options = {}) ⇒ Role
-
#create_saml_provider(options = {}) ⇒ SamlProvider
-
#create_server_certificate(options = {}) ⇒ ServerCertificate
-
#create_signing_certificate(options = {}) ⇒ SigningCertificate
-
#create_user(options = {}) ⇒ User
-
#create_virtual_mfa_device(options = {}) ⇒ VirtualMfaDevice
Associations collapse
-
#account_password_policy ⇒ AccountPasswordPolicy
-
#account_summary ⇒ AccountSummary
-
#current_user ⇒ CurrentUser
-
#group(name) ⇒ Group
-
#groups(options = {}) ⇒ Group::Collection
-
#instance_profile(name) ⇒ InstanceProfile
-
#instance_profiles(options = {}) ⇒ InstanceProfile::Collection
-
#policies(options = {}) ⇒ Policy::Collection
-
#policy(arn) ⇒ Policy
-
#role(name) ⇒ Role
-
#roles(options = {}) ⇒ Role::Collection
-
#saml_provider(arn) ⇒ SamlProvider
-
#saml_providers(options = {}) ⇒ SamlProvider::Collection
-
#server_certificate(name) ⇒ ServerCertificate
-
#server_certificates(options = {}) ⇒ ServerCertificate::Collection
-
#user(name) ⇒ User
-
#users(options = {}) ⇒ User::Collection
-
#virtual_mfa_device(serial_number) ⇒ VirtualMfaDevice
-
#virtual_mfa_devices(options = {}) ⇒ VirtualMfaDevice::Collection
Instance Method Summary collapse
-
#client ⇒ Client
-
#delete_account_alias ⇒ Seahorse::Client::Response, false
Returns the response from Client#delete_account_alias if an alias was deleted.
-
#initialize(options = {}) ⇒ Resource
constructor
A new instance of Resource.
Constructor Details
Instance Method Details
#account_password_policy ⇒ AccountPasswordPolicy
988 989 990 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/resource.rb', line 988 def account_password_policy AccountPasswordPolicy.new(client: @client) end |
#account_summary ⇒ AccountSummary
993 994 995 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/resource.rb', line 993 def account_summary AccountSummary.new(client: @client) end |
#change_password(options = {}) ⇒ EmptyStructure
65 66 67 68 69 70 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/resource.rb', line 65 def change_password( = {}) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.change_password() end resp.data end |
#client ⇒ Client
32 33 34 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/resource.rb', line 32 def client @client end |
#create_account_alias(options = {}) ⇒ EmptyStructure
90 91 92 93 94 95 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/resource.rb', line 90 def create_account_alias( = {}) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.create_account_alias() end resp.data end |
#create_account_password_policy(options = {}) ⇒ AccountPasswordPolicy
195 196 197 198 199 200 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/resource.rb', line 195 def create_account_password_policy( = {}) Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.update_account_password_policy() end AccountPasswordPolicy.new(client: @client) end |
#create_group(options = {}) ⇒ Group
235 236 237 238 239 240 241 242 243 244 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/resource.rb', line 235 def create_group( = {}) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.create_group() end Group.new( name: [:group_name], data: resp.data.group, client: @client ) end |
#create_instance_profile(options = {}) ⇒ InstanceProfile
304 305 306 307 308 309 310 311 312 313 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/resource.rb', line 304 def create_instance_profile( = {}) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.create_instance_profile() end InstanceProfile.new( name: [:instance_profile_name], data: resp.data.instance_profile, client: @client ) end |
#create_policy(options = {}) ⇒ Policy
419 420 421 422 423 424 425 426 427 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/resource.rb', line 419 def create_policy( = {}) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.create_policy() end Policy.new( arn: resp.data.policy.arn, client: @client ) end |
#create_role(options = {}) ⇒ Role
570 571 572 573 574 575 576 577 578 579 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/resource.rb', line 570 def create_role( = {}) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.create_role() end Role.new( name: [:role_name], data: resp.data.role, client: @client ) end |
#create_saml_provider(options = {}) ⇒ SamlProvider
643 644 645 646 647 648 649 650 651 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/resource.rb', line 643 def create_saml_provider( = {}) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.create_saml_provider() end SamlProvider.new( arn: resp.data.saml_provider_arn, client: @client ) end |
#create_server_certificate(options = {}) ⇒ ServerCertificate
775 776 777 778 779 780 781 782 783 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/resource.rb', line 775 def create_server_certificate( = {}) Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.upload_server_certificate() end ServerCertificate.new( name: [:server_certificate_name], client: @client ) end |
#create_signing_certificate(options = {}) ⇒ SigningCertificate
822 823 824 825 826 827 828 829 830 831 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/resource.rb', line 822 def create_signing_certificate( = {}) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.upload_signing_certificate() end SigningCertificate.new( id: resp.data.certificate.certificate_id, data: resp.data.certificate, client: @client ) end |
#create_user(options = {}) ⇒ User
904 905 906 907 908 909 910 911 912 913 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/resource.rb', line 904 def create_user( = {}) 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_virtual_mfa_device(options = {}) ⇒ VirtualMfaDevice
974 975 976 977 978 979 980 981 982 983 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/resource.rb', line 974 def create_virtual_mfa_device( = {}) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.create_virtual_mfa_device() end VirtualMfaDevice.new( serial_number: resp.data.virtual_mfa_device.serial_number, data: resp.data.virtual_mfa_device, client: @client ) end |
#current_user ⇒ CurrentUser
998 999 1000 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/resource.rb', line 998 def current_user CurrentUser.new(client: @client) end |
#delete_account_alias ⇒ Seahorse::Client::Response, false
Returns the response
from Client#delete_account_alias if an alias was deleted.
Returns false if this account had no alias to remove.
11 12 13 14 15 16 17 18 19 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/customizations/resource.rb', line 11 def delete_account_alias Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do if name = @client.list_account_aliases.account_aliases.first @client.delete_account_alias(account_alias: name) else false end end end |
#group(name) ⇒ Group
1004 1005 1006 1007 1008 1009 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/resource.rb', line 1004 def group(name) Group.new( name: name, client: @client ) end |
#groups(options = {}) ⇒ Group::Collection
1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/resource.rb', line 1034 def groups( = {}) batches = Enumerator.new do |y| resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.list_groups() 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 |
#instance_profile(name) ⇒ InstanceProfile
1056 1057 1058 1059 1060 1061 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/resource.rb', line 1056 def instance_profile(name) InstanceProfile.new( name: name, client: @client ) end |
#instance_profiles(options = {}) ⇒ InstanceProfile::Collection
1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/resource.rb', line 1087 def instance_profiles( = {}) batches = Enumerator.new do |y| resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.list_instance_profiles() end 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 end InstanceProfile::Collection.new(batches) end |
#policies(options = {}) ⇒ Policy::Collection
1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/resource.rb', line 1155 def policies( = {}) batches = Enumerator.new do |y| resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.list_policies() end resp.each_page do |page| batch = [] page.data.policies.each do |p| batch << Policy.new( arn: p.arn, data: p, client: @client ) end y.yield(batch) end end Policy::Collection.new(batches) end |
#policy(arn) ⇒ Policy
1177 1178 1179 1180 1181 1182 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/resource.rb', line 1177 def policy(arn) Policy.new( arn: arn, client: @client ) end |
#role(name) ⇒ Role
1186 1187 1188 1189 1190 1191 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/resource.rb', line 1186 def role(name) Role.new( name: name, client: @client ) end |
#roles(options = {}) ⇒ Role::Collection
1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/resource.rb', line 1216 def roles( = {}) batches = Enumerator.new do |y| resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.list_roles() end resp.each_page do |page| batch = [] page.data.roles.each do |r| batch << Role.new( name: r.role_name, data: r, client: @client ) end y.yield(batch) end end Role::Collection.new(batches) end |
#saml_provider(arn) ⇒ SamlProvider
1238 1239 1240 1241 1242 1243 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/resource.rb', line 1238 def saml_provider(arn) SamlProvider.new( arn: arn, client: @client ) end |
#saml_providers(options = {}) ⇒ SamlProvider::Collection
1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/resource.rb', line 1250 def saml_providers( = {}) batches = Enumerator.new do |y| batch = [] resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.list_saml_providers() end resp.data.saml_provider_list.each do |s| batch << SamlProvider.new( arn: s.arn, client: @client ) end y.yield(batch) end SamlProvider::Collection.new(batches) end |
#server_certificate(name) ⇒ ServerCertificate
1269 1270 1271 1272 1273 1274 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/resource.rb', line 1269 def server_certificate(name) ServerCertificate.new( name: name, client: @client ) end |
#server_certificates(options = {}) ⇒ ServerCertificate::Collection
1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/resource.rb', line 1300 def server_certificates( = {}) batches = Enumerator.new do |y| resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.list_server_certificates() end resp.each_page do |page| batch = [] page.data..each do |s| batch << ServerCertificate.new( name: s.server_certificate_name, client: @client ) end y.yield(batch) end end ServerCertificate::Collection.new(batches) end |
#user(name) ⇒ User
1321 1322 1323 1324 1325 1326 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/resource.rb', line 1321 def user(name) User.new( name: name, client: @client ) end |
#users(options = {}) ⇒ User::Collection
1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/resource.rb', line 1351 def users( = {}) batches = Enumerator.new do |y| resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.list_users() end resp.each_page do |page| batch = [] page.data.users.each do |u| batch << User.new( name: u.user_name, data: u, client: @client ) end y.yield(batch) end end User::Collection.new(batches) end |
#virtual_mfa_device(serial_number) ⇒ VirtualMfaDevice
1373 1374 1375 1376 1377 1378 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/resource.rb', line 1373 def virtual_mfa_device(serial_number) VirtualMfaDevice.new( serial_number: serial_number, client: @client ) end |
#virtual_mfa_devices(options = {}) ⇒ VirtualMfaDevice::Collection
1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/resource.rb', line 1391 def virtual_mfa_devices( = {}) batches = Enumerator.new do |y| resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.list_virtual_mfa_devices() end resp.each_page do |page| batch = [] page.data.virtual_mfa_devices.each do |v| batch << VirtualMfaDevice.new( serial_number: v.serial_number, data: v, client: @client ) end y.yield(batch) end end VirtualMfaDevice::Collection.new(batches) end |