You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::IAM::AccessKey

Inherits:
Object
  • Object
show all
Defined in:
gems/aws-sdk-iam/lib/aws-sdk-iam/access_key.rb

Defined Under Namespace

Classes: Collection

Actions collapse

Associations collapse

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

#initialize(user_name, id, options = {}) ⇒ AccessKey #initialize(options = {}) ⇒ AccessKey

Returns a new instance of AccessKey

Overloads:

  • #initialize(user_name, id, options = {}) ⇒ AccessKey

    Parameters:

    • user_name (String)
    • id (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ AccessKey

    Options Hash (options):

    • :user_name (required, String)
    • :id (required, String)
    • :client (Client)


21
22
23
24
25
26
27
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/access_key.rb', line 21

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @user_name = extract_user_name(args, options)
  @id = extract_id(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
end

Instance Method Details

#activate(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


access_key.activate()

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Returns:

  • (EmptyStructure)


92
93
94
95
96
97
98
99
100
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/access_key.rb', line 92

def activate(options = {})
  options = options.merge(
    user_name: @user_name,
    access_key_id: @id,
    status: "Active"
  )
  resp = @client.update_access_key(options)
  resp.data
end

#clientClient

Returns:



58
59
60
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/access_key.rb', line 58

def client
  @client
end

#create_dateTime

The date when the access key was created.

Returns:

  • (Time)


51
52
53
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/access_key.rb', line 51

def create_date
  data.create_date
end

#dataTypes::AccessKeyMetadata

Returns the data for this Aws::IAM::AccessKey.

Returns:

Raises:



73
74
75
76
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/access_key.rb', line 73

def data
  load unless @data
  @data
end

#data_loaded?Boolean

Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.

Returns:

  • (Boolean)

    Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.



81
82
83
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/access_key.rb', line 81

def data_loaded?
  !!@data
end

#deactivate(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


access_key.deactivate()

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Returns:

  • (EmptyStructure)


107
108
109
110
111
112
113
114
115
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/access_key.rb', line 107

def deactivate(options = {})
  options = options.merge(
    user_name: @user_name,
    access_key_id: @id,
    status: "Inactive"
  )
  resp = @client.update_access_key(options)
  resp.data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


access_key.delete()

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Returns:

  • (EmptyStructure)


122
123
124
125
126
127
128
129
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/access_key.rb', line 122

def delete(options = {})
  options = options.merge(
    user_name: @user_name,
    access_key_id: @id
  )
  resp = @client.delete_access_key(options)
  resp.data
end

#idString Also known as: access_key_id

Returns:

  • (String)


37
38
39
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/access_key.rb', line 37

def id
  @id
end

#statusString

The status of the access key. Active means the key is valid for API calls; Inactive means it is not.

Returns:

  • (String)


45
46
47
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/access_key.rb', line 45

def status
  data.status
end

#userUser

Returns:



134
135
136
137
138
139
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/access_key.rb', line 134

def user
  User.new(
    name: @user_name,
    client: @client
  )
end

#user_nameString

Returns:

  • (String)


32
33
34
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/access_key.rb', line 32

def user_name
  @user_name
end