class Aws::IAM::SigningCertificate

Public Class Methods

new(*args) click to toggle source

@overload def initialize(user_name, id, options = {})

@param [String] user_name
@param [String] id
@option options [Client] :client

@overload def initialize(options = {})

@option options [required, String] :user_name
@option options [required, String] :id
@option options [Client] :client
# File lib/aws-sdk-iam/signing_certificate.rb, line 24
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)
  @waiter_block_warned = false
end

Public Instance Methods

activate(options = {}) click to toggle source

@example Request syntax with placeholder values

signing_certificate.activate()

@param [Hash] options ({}) @return [EmptyStructure]

# File lib/aws-sdk-iam/signing_certificate.rb, line 199
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_body() click to toggle source

The contents of the signing certificate. @return [String]

# File lib/aws-sdk-iam/signing_certificate.rb, line 48
def certificate_body
  data[:certificate_body]
end
certificate_id()
Alias for: id
client() click to toggle source

@return [Client]

# File lib/aws-sdk-iam/signing_certificate.rb, line 68
def client
  @client
end
data() click to toggle source

@raise [NotImplementedError] Raises when {#data_loaded?} is `false`. @return [Types::SigningCertificate]

Returns the data for this {SigningCertificate}.
# File lib/aws-sdk-iam/signing_certificate.rb, line 83
def data
  load unless @data
  @data
end
data_loaded?() click to toggle source

@return [Boolean]

Returns `true` if this resource is loaded.  Accessing attributes or
{#data} on an unloaded resource will trigger a call to {#load}.
# File lib/aws-sdk-iam/signing_certificate.rb, line 91
def data_loaded?
  !!@data
end
deactivate(options = {}) click to toggle source

@example Request syntax with placeholder values

signing_certificate.deactivate()

@param [Hash] options ({}) @return [EmptyStructure]

# File lib/aws-sdk-iam/signing_certificate.rb, line 214
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 = {}) click to toggle source

@example Request syntax with placeholder values

signing_certificate.delete()

@param [Hash] options ({}) @return [EmptyStructure]

# File lib/aws-sdk-iam/signing_certificate.rb, line 229
def delete(options = {})
  options = options.merge(
    user_name: @user_name,
    certificate_id: @id
  )
  resp = @client.delete_signing_certificate(options)
  resp.data
end
id() click to toggle source

@return [String]

# File lib/aws-sdk-iam/signing_certificate.rb, line 41
def id
  @id
end
Also aliased as: certificate_id
identifiers() click to toggle source

@deprecated @api private

# File lib/aws-sdk-iam/signing_certificate.rb, line 250
def identifiers
  {
    user_name: @user_name,
    id: @id
  }
end
load() click to toggle source

@raise [NotImplementedError] @api private

# File lib/aws-sdk-iam/signing_certificate.rb, line 74
def load
  msg = "#load is not implemented, data only available via enumeration"
  raise NotImplementedError, msg
end
Also aliased as: reload
reload()
Alias for: load
status() click to toggle source

The status of the signing certificate. `Active` means that the key is valid for API calls, while `Inactive` means it is not. @return [String]

# File lib/aws-sdk-iam/signing_certificate.rb, line 55
def status
  data[:status]
end
upload_date() click to toggle source

The date when the signing certificate was uploaded. @return [Time]

# File lib/aws-sdk-iam/signing_certificate.rb, line 61
def upload_date
  data[:upload_date]
end
user() click to toggle source

@return [User]

# File lib/aws-sdk-iam/signing_certificate.rb, line 241
def user
  User.new(
    name: @user_name,
    client: @client
  )
end
user_name() click to toggle source

@return [String]

# File lib/aws-sdk-iam/signing_certificate.rb, line 36
def user_name
  @user_name
end
wait_until(options = {}, &block) click to toggle source

@deprecated Use [Aws::IAM::Client] wait_until instead

Waiter polls an API operation until a resource enters a desired state.

@note The waiting operation is performed on a copy. The original resource

remains unchanged.

## 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(options) {|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

@yieldparam [Resource] resource to be used in the waiting condition.

@raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter

terminates because the waiter has entered a state that it will not
transition out of, preventing success.

yet successful.

@raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is

encountered while polling for a resource that is not expected.

@raise [NotImplementedError] Raised when the resource does not

@option options [Integer] :max_attempts (10) Maximum number of attempts @option options [Integer] :delay (10) Delay between each attempt in seconds @option options [Proc] :before_attempt (nil) Callback invoked before each attempt @option options [Proc] :before_wait (nil) Callback invoked before each wait @return [Resource] if the waiter was successful

# File lib/aws-sdk-iam/signing_certificate.rb, line 175
def wait_until(options = {}, &block)
  self_copy = self.dup
  attempts = 0
  options[:max_attempts] = 10 unless options.key?(:max_attempts)
  options[:delay] ||= 10
  options[:poller] = Proc.new do
    attempts += 1
    if block.call(self_copy)
      [:success, self_copy]
    else
      self_copy.reload unless attempts == options[:max_attempts]
      :retry
    end
  end
  Aws::Waiters::Waiter.new(options).wait({})
end

Private Instance Methods

extract_id(args, options) click to toggle source
# File lib/aws-sdk-iam/signing_certificate.rb, line 271
def extract_id(args, options)
  value = args[1] || options.delete(:id)
  case value
  when String then value
  when nil then raise ArgumentError, "missing required option :id"
  else
    msg = "expected :id to be a String, got #{value.class}"
    raise ArgumentError, msg
  end
end
extract_user_name(args, options) click to toggle source
# File lib/aws-sdk-iam/signing_certificate.rb, line 260
def extract_user_name(args, options)
  value = args[0] || options.delete(:user_name)
  case value
  when String then value
  when nil then raise ArgumentError, "missing required option :user_name"
  else
    msg = "expected :user_name to be a String, got #{value.class}"
    raise ArgumentError, msg
  end
end