class Aws::IAM::ServerCertificate
Public Class Methods
@overload def initialize(name, options = {})
@param [String] name @option options [Client] :client
@overload def initialize(options = {})
@option options [required, String] :name @option options [Client] :client
# File lib/aws-sdk-iam/server_certificate.rb, line 22 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) @waiter_block_warned = false end
Public Instance Methods
The contents of the public key certificate. @return [String]
# File lib/aws-sdk-iam/server_certificate.rb, line 46 def certificate_body data[:certificate_body] end
The contents of the public key certificate chain. @return [String]
# File lib/aws-sdk-iam/server_certificate.rb, line 52 def certificate_chain data[:certificate_chain] end
@return [Client]
# File lib/aws-sdk-iam/server_certificate.rb, line 71 def client @client end
@return [Types::ServerCertificate]
Returns the data for this {ServerCertificate}. Calls {Client#get_server_certificate} if {#data_loaded?} is `false`.
# File lib/aws-sdk-iam/server_certificate.rb, line 91 def data load unless @data @data end
@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/server_certificate.rb, line 99 def data_loaded? !!@data end
@example Request syntax with placeholder values
server_certificate.delete()
@param [Hash] options ({}) @return [EmptyStructure]
# File lib/aws-sdk-iam/server_certificate.rb, line 207 def delete(options = {}) options = options.merge(server_certificate_name: @name) resp = @client.delete_server_certificate(options) resp.data end
@deprecated @api private
# File lib/aws-sdk-iam/server_certificate.rb, line 259 def identifiers { name: @name } end
Loads, or reloads {#data} for the current {ServerCertificate}. Returns `self` making it possible to chain methods.
server_certificate.reload.data
@return [self]
# File lib/aws-sdk-iam/server_certificate.rb, line 81 def load resp = @client.get_server_certificate(server_certificate_name: @name) @data = resp.server_certificate self end
@return [String]
# File lib/aws-sdk-iam/server_certificate.rb, line 33 def name @name end
The meta information of the server certificate, such as its name, path, ID, and ARN. @return [Types::ServerCertificateMetadata]
# File lib/aws-sdk-iam/server_certificate.rb, line 40 def server_certificate_metadata data[:server_certificate_metadata] end
@example Request syntax with placeholder values
servercertificate = server_certificate.update({ new_path: "pathType", new_server_certificate_name: "serverCertificateNameType", })
@param [Hash] options ({}) @option options [String] :new_path
The new path for the server certificate. Include this only if you are updating the server certificate's path. This parameter allows (through its [regex pattern][1]) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (`\u0021`) through the DEL character (`\u007F`), including most punctuation characters, digits, and upper and lowercased letters. [1]: http://wikipedia.org/wiki/regex
@option options [String] :new_server_certificate_name
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 (through its [regex pattern][1]) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: \_+=,.@- [1]: http://wikipedia.org/wiki/regex
@return [ServerCertificate]
# File lib/aws-sdk-iam/server_certificate.rb, line 248 def update(options = {}) options = options.merge(server_certificate_name: @name) @client.update_server_certificate(options) ServerCertificate.new( name: options[:new_server_certificate_name], client: @client ) end
@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/server_certificate.rb, line 183 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
# File lib/aws-sdk-iam/server_certificate.rb, line 266 def extract_name(args, options) value = args[0] || options.delete(:name) case value when String then value when nil then raise ArgumentError, "missing required option :name" else msg = "expected :name to be a String, got #{value.class}" raise ArgumentError, msg end end