Class: AWS::IAM::AccountAliasCollection

Inherits:

Object

• Object
• AWS::IAM::AccountAliasCollection

Includes:

Collection

Defined in:

lib/aws/iam/account_alias_collection.rb

Overview

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.

Instance Attribute Summary

Attributes included from Core::Model

#config

Instance Method Summary

• #create(account_alias) ⇒ String

  Creates an AWS account alias.

• #delete(account_alias) ⇒ nil

  Delete an AWS account alias.

Methods included from Core::Collection::Limitable

#each_batch

Methods included from Core::Collection

#each, #each_batch, #enum, #first, #in_groups_of, #page

Methods included from Core::Model

#client, #config_prefix, #initialize, #inspect

Instance Method Details

#create(account_alias) ⇒ String

Creates an AWS account alias.

iam.account_aliases.create('myaccountalias')

For information about account alias restrictions and usage, see docs.amazonwebservices.com/IAM/latest/UserGuide/index.html?AccountAlias.html.

Parameters:

• account_alias (String)

Returns:

• (String) —

  Returns the account_alias string that was passed.

# File 'lib/aws/iam/account_alias_collection.rb', line 47

def create account_alias
  client.create_account_alias(:account_alias => account_alias)
  account_alias
end

#delete(account_alias) ⇒ nil

Delete an AWS account alias.

iam.account_aliases.delete('myaccountalias')

Parameters:

• account_alias (String) —

  The account alias to delete.

Returns:

• (nil)

# File 'lib/aws/iam/account_alias_collection.rb', line 58

def delete account_alias
  client.delete_account_alias(:account_alias => account_alias)
  nil
end