Class: Aws::RDS::Certificate
- Inherits:
-
Object
- Object
- Aws::RDS::Certificate
- Extended by:
- Deprecations
- Defined in:
- lib/aws-sdk-rds/certificate.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
-
#certificate_arn ⇒ String
The Amazon Resource Name (ARN) for the certificate.
-
#certificate_type ⇒ String
The type of the certificate.
- #id ⇒ String (also: #certificate_identifier)
-
#thumbprint ⇒ String
The thumbprint of the certificate.
-
#valid_from ⇒ Time
The starting date from which the certificate is valid.
-
#valid_till ⇒ Time
The final date that the certificate continues to be valid.
Instance Method Summary collapse
- #client ⇒ Client
-
#data ⇒ Types::Certificate
Returns the data for this Certificate.
-
#data_loaded? ⇒ Boolean
Returns ‘true` if this resource is loaded.
- #identifiers ⇒ Object deprecated private Deprecated.
-
#initialize(*args) ⇒ Certificate
constructor
A new instance of Certificate.
-
#load ⇒ self
(also: #reload)
Loads, or reloads #data for the current Certificate.
-
#wait_until(options = {}, &block) ⇒ Resource
deprecated
Deprecated.
Use [Aws::RDS::Client] #wait_until instead
Constructor Details
#initialize(id, options = {}) ⇒ Certificate #initialize(options = {}) ⇒ Certificate
Returns a new instance of Certificate.
19 20 21 22 23 24 |
# File 'lib/aws-sdk-rds/certificate.rb', line 19 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @id = extract_id(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() end |
Instance Method Details
#certificate_arn ⇒ String
The Amazon Resource Name (ARN) for the certificate.
60 61 62 |
# File 'lib/aws-sdk-rds/certificate.rb', line 60 def certificate_arn data[:certificate_arn] end |
#certificate_type ⇒ String
The type of the certificate.
36 37 38 |
# File 'lib/aws-sdk-rds/certificate.rb', line 36 def certificate_type data[:certificate_type] end |
#data ⇒ Types::Certificate
Returns the data for this Aws::RDS::Certificate. Calls Aws::RDS::Client#describe_certificates if #data_loaded? is ‘false`.
87 88 89 90 |
# File 'lib/aws-sdk-rds/certificate.rb', line 87 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
95 96 97 |
# File 'lib/aws-sdk-rds/certificate.rb', line 95 def data_loaded? !!@data end |
#id ⇒ String Also known as: certificate_identifier
29 30 31 |
# File 'lib/aws-sdk-rds/certificate.rb', line 29 def id @id end |
#identifiers ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
196 197 198 |
# File 'lib/aws-sdk-rds/certificate.rb', line 196 def identifiers { id: @id } end |
#load ⇒ self Also known as: reload
Loads, or reloads #data for the current Aws::RDS::Certificate. Returns ‘self` making it possible to chain methods.
certificate.reload.data
77 78 79 80 81 |
# File 'lib/aws-sdk-rds/certificate.rb', line 77 def load resp = @client.describe_certificates(certificate_identifier: @id) @data = resp.certificates[0] self end |
#thumbprint ⇒ String
The thumbprint of the certificate.
42 43 44 |
# File 'lib/aws-sdk-rds/certificate.rb', line 42 def thumbprint data[:thumbprint] end |
#valid_from ⇒ Time
The starting date from which the certificate is valid.
48 49 50 |
# File 'lib/aws-sdk-rds/certificate.rb', line 48 def valid_from data[:valid_from] end |
#valid_till ⇒ Time
The final date that the certificate continues to be valid.
54 55 56 |
# File 'lib/aws-sdk-rds/certificate.rb', line 54 def valid_till data[:valid_till] end |
#wait_until(options = {}, &block) ⇒ Resource
Use [Aws::RDS::Client] #wait_until instead
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() {|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
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 |
# File 'lib/aws-sdk-rds/certificate.rb', line 177 def wait_until( = {}, &block) self_copy = self.dup attempts = 0 [:max_attempts] = 10 unless .key?(:max_attempts) [:delay] ||= 10 [:poller] = Proc.new do attempts += 1 if block.call(self_copy) [:success, self_copy] else self_copy.reload unless attempts == [:max_attempts] :retry end end Aws::Waiters::Waiter.new().wait({}) end |