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

Class: Aws::IAM::SigningCertificate

Inherits:
Object
  • Object
show all
Defined in:
gems/aws-sdk-iam/lib/aws-sdk-iam/signing_certificate.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 = {}) ⇒ SigningCertificate #initialize(options = {}) ⇒ SigningCertificate

Returns a new instance of SigningCertificate

Overloads:

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

    Parameters:

    • user_name (String)
    • id (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ SigningCertificate

    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/signing_certificate.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


signing_certificate.activate()

Parameters:

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

    ({})

Returns:

  • (EmptyStructure)


98
99
100
101
102
103
104
105
106
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/signing_certificate.rb', line 98

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

#certificate_bodyString

The contents of the signing certificate.

Returns:

  • (String)


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

def certificate_body
  data.certificate_body
end

#clientClient

Returns:



64
65
66
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/signing_certificate.rb', line 64

def client
  @client
end

#dataTypes::SigningCertificate

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

Returns:

Raises:



79
80
81
82
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/signing_certificate.rb', line 79

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.



87
88
89
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/signing_certificate.rb', line 87

def data_loaded?
  !!@data
end

#deactivate(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


signing_certificate.deactivate()

Parameters:

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

    ({})

Returns:

  • (EmptyStructure)


113
114
115
116
117
118
119
120
121
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/signing_certificate.rb', line 113

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

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


signing_certificate.delete()

Parameters:

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

    ({})

Returns:

  • (EmptyStructure)


128
129
130
131
132
133
134
135
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/signing_certificate.rb', line 128

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

#idString Also known as: certificate_id

Returns:

  • (String)


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

def id
  @id
end

#statusString

The status of the signing certificate. Active means the key is valid for API calls, while Inactive means it is not.

Returns:

  • (String)


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

def status
  data.status
end

#upload_dateTime

The date when the signing certificate was uploaded.

Returns:

  • (Time)


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

def upload_date
  data.upload_date
end

#userUser

Returns:



140
141
142
143
144
145
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/signing_certificate.rb', line 140

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/signing_certificate.rb', line 32

def user_name
  @user_name
end