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

Class: Aws::IAM::ServerCertificate

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

Defined Under Namespace

Classes: Collection

Actions collapse

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, options = {}) ⇒ ServerCertificate #initialize(options = {}) ⇒ ServerCertificate

Returns a new instance of ServerCertificate

Overloads:

  • #initialize(name, options = {}) ⇒ ServerCertificate

    Parameters:

    • name (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ ServerCertificate

    Options Hash (options):

    • :name (required, String)
    • :client (Client)


19
20
21
22
23
24
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/server_certificate.rb', line 19

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

Instance Method Details

#certificate_bodyString

The contents of the public key certificate.

Returns:

  • (String)


42
43
44
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/server_certificate.rb', line 42

def certificate_body
  data[:certificate_body]
end

#certificate_chainString

The contents of the public key certificate chain.

Returns:

  • (String)


48
49
50
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/server_certificate.rb', line 48

def certificate_chain
  data[:certificate_chain]
end

#clientClient

Returns:



55
56
57
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/server_certificate.rb', line 55

def client
  @client
end

#dataTypes::ServerCertificate

Returns the data for this Aws::IAM::ServerCertificate. Calls Client#get_server_certificate if #data_loaded? is false.

Returns:



75
76
77
78
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/server_certificate.rb', line 75

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.



83
84
85
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/server_certificate.rb', line 83

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


server_certificate.delete()

Parameters:

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

    ({})

Returns:

  • (EmptyStructure)


189
190
191
192
193
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/server_certificate.rb', line 189

def delete(options = {})
  options = options.merge(server_certificate_name: @name)
  resp = @client.delete_server_certificate(options)
  resp.data
end

#loadself Also known as: reload

Loads, or reloads #data for the current Aws::IAM::ServerCertificate. Returns self making it possible to chain methods.

server_certificate.reload.data

Returns:

  • (self)


65
66
67
68
69
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/server_certificate.rb', line 65

def load
  resp = @client.get_server_certificate(server_certificate_name: @name)
  @data = resp.server_certificate
  self
end

#nameString

Returns:

  • (String)


29
30
31
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/server_certificate.rb', line 29

def name
  @name
end

#server_certificate_metadataTypes::ServerCertificateMetadata

The meta information of the server certificate, such as its name, path, ID, and ARN.



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

def 
  data[:server_certificate_metadata]
end

#update(options = {}) ⇒ ServerCertificate

Examples:

Request syntax with placeholder values


servercertificate = server_certificate.update({
  new_path: "pathType",
  new_server_certificate_name: "serverCertificateNameType",
})

Parameters:

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

    ({})

Options Hash (options):

  • :new_path (String)

    The new path for the server certificate. Include this only if you are updating the server certificate's path.

    This paramater allows (per its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\u0021) thru the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

  • :new_server_certificate_name (String)

    The new name for the server certificate. Include this only if you are updating the server certificate's name. The name of the certificate cannot contain any spaces.

    This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Returns:



230
231
232
233
234
235
236
237
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/server_certificate.rb', line 230

def update(options = {})
  options = options.merge(server_certificate_name: @name)
  resp = @client.update_server_certificate(options)
  ServerCertificate.new(
    name: options[:new_server_certificate_name],
    client: @client
  )
end

#wait_until(options = {}, &block) ⇒ Resource

Deprecated.

Use [Aws::IAM::Client] #wait_until instead

Note:

The waiting operation is performed on a copy. The original resource remains unchanged

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

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) {|instance| instance.state.name == 'running' }

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

attempts attempt in seconds invoked before each attempt invoked before each wait

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :max_attempts (Integer) — default: 10

    Maximum number of

  • :delay (Integer) — default: 10

    Delay between each

  • :before_attempt (Proc) — default: nil

    Callback

  • :before_wait (Proc) — default: nil

    Callback

Returns:

  • (Resource)

    if the waiter was successful

Raises:

  • (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.

  • (Aws::Waiters::Errors::UnexpectedError)

    Raised when an error is encountered while polling for a resource that is not expected.

  • (NotImplementedError)

    Raised when the resource does not



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/server_certificate.rb', line 165

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