Class: Aws::IAM::ServerCertificate
- Inherits:
-
Object
- Object
- Aws::IAM::ServerCertificate
- Defined in:
- gems/aws-sdk-iam/lib/aws-sdk-iam/server_certificate.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
-
#certificate_body ⇒ String
The contents of the public key certificate.
-
#certificate_chain ⇒ String
The contents of the public key certificate chain.
-
#name ⇒ String
-
#server_certificate_metadata ⇒ Types::ServerCertificateMetadata
The meta information of the server certificate, such as its name, path, ID, and ARN.
-
#tags ⇒ Array<Types::Tag>
A list of tags that are attached to the server certificate.
Actions collapse
Instance Method Summary collapse
-
#client ⇒ Client
-
#data ⇒ Types::ServerCertificate
Returns the data for this ServerCertificate.
-
#data_loaded? ⇒ Boolean
Returns
true
if this resource is loaded. -
#initialize(*args) ⇒ ServerCertificate
constructor
A new instance of ServerCertificate.
-
#load ⇒ self
(also: #reload)
Loads, or reloads #data for the current ServerCertificate.
-
#wait_until(options = {}) {|resource| ... } ⇒ Resource
deprecated
Deprecated.
Use [Aws::IAM::Client] #wait_until instead
Constructor Details
#initialize(name, options = {}) ⇒ ServerCertificate #initialize(options = {}) ⇒ ServerCertificate
Returns a new instance of ServerCertificate.
22 23 24 25 26 27 28 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/server_certificate.rb', line 22 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @name = extract_name(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() @waiter_block_warned = false end |
Instance Method Details
#certificate_body ⇒ String
The contents of the public key certificate.
46 47 48 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/server_certificate.rb', line 46 def certificate_body data[:certificate_body] end |
#certificate_chain ⇒ String
The contents of the public key certificate chain.
52 53 54 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/server_certificate.rb', line 52 def certificate_chain data[:certificate_chain] end |
#client ⇒ Client
71 72 73 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/server_certificate.rb', line 71 def client @client end |
#data ⇒ Types::ServerCertificate
Returns the data for this Aws::IAM::ServerCertificate. Calls
Client#get_server_certificate if #data_loaded? is false
.
91 92 93 94 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/server_certificate.rb', line 91 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
99 100 101 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/server_certificate.rb', line 99 def data_loaded? !!@data end |
#delete(options = {}) ⇒ EmptyStructure
207 208 209 210 211 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/server_certificate.rb', line 207 def delete( = {}) = .merge(server_certificate_name: @name) resp = @client.delete_server_certificate() resp.data end |
#load ⇒ self 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
81 82 83 84 85 |
# File 'gems/aws-sdk-iam/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 |
#name ⇒ String
33 34 35 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/server_certificate.rb', line 33 def name @name end |
#server_certificate_metadata ⇒ Types::ServerCertificateMetadata
The meta information of the server certificate, such as its name, path, ID, and ARN.
40 41 42 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/server_certificate.rb', line 40 def data[:server_certificate_metadata] end |
#tags ⇒ Array<Types::Tag>
A list of tags that are attached to the server certificate. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
64 65 66 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/server_certificate.rb', line 64 def data[:tags] end |
#update(options = {}) ⇒ ServerCertificate
248 249 250 251 252 253 254 255 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/server_certificate.rb', line 248 def update( = {}) = .merge(server_certificate_name: @name) @client.update_server_certificate() ServerCertificate.new( name: [:new_server_certificate_name], client: @client ) end |
#wait_until(options = {}) {|resource| ... } ⇒ Resource
Use [Aws::IAM::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) 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
attempts attempt in seconds invoked before each attempt invoked before each wait
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/server_certificate.rb', line 183 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 |