Class: Aws::IAM::SamlProvider
- Inherits:
-
Object
- Object
- Aws::IAM::SamlProvider
- Extended by:
- Deprecations
- Defined in:
- lib/aws-sdk-iam/saml_provider.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
- #arn ⇒ String
-
#create_date ⇒ Time
The date and time when the SAML provider was created.
-
#saml_metadata_document ⇒ String
The XML metadata document that includes information about an identity provider.
-
#valid_until ⇒ Time
The expiration date and time for the SAML provider.
Actions collapse
- #delete(options = {}) ⇒ EmptyStructure
- #identifiers ⇒ Object deprecated private Deprecated.
- #update(options = {}) ⇒ Types::UpdateSAMLProviderResponse
Instance Method Summary collapse
- #client ⇒ Client
-
#data ⇒ Types::GetSAMLProviderResponse
Returns the data for this SamlProvider.
-
#data_loaded? ⇒ Boolean
Returns ‘true` if this resource is loaded.
-
#initialize(*args) ⇒ SamlProvider
constructor
A new instance of SamlProvider.
-
#load ⇒ self
(also: #reload)
Loads, or reloads #data for the current SamlProvider.
-
#wait_until(options = {}) {|resource| ... } ⇒ Resource
deprecated
Deprecated.
Use [Aws::IAM::Client] #wait_until instead
Constructor Details
#initialize(arn, options = {}) ⇒ SamlProvider #initialize(options = {}) ⇒ SamlProvider
Returns a new instance of SamlProvider.
22 23 24 25 26 27 28 |
# File 'lib/aws-sdk-iam/saml_provider.rb', line 22 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @arn = extract_arn(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() @waiter_block_warned = false end |
Instance Method Details
#arn ⇒ String
33 34 35 |
# File 'lib/aws-sdk-iam/saml_provider.rb', line 33 def arn @arn end |
#create_date ⇒ Time
The date and time when the SAML provider was created.
46 47 48 |
# File 'lib/aws-sdk-iam/saml_provider.rb', line 46 def create_date data[:create_date] end |
#data ⇒ Types::GetSAMLProviderResponse
Returns the data for this Aws::IAM::SamlProvider. Calls Client#get_saml_provider if #data_loaded? is ‘false`.
79 80 81 82 |
# File 'lib/aws-sdk-iam/saml_provider.rb', line 79 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
87 88 89 |
# File 'lib/aws-sdk-iam/saml_provider.rb', line 87 def data_loaded? !!@data end |
#delete(options = {}) ⇒ EmptyStructure
195 196 197 198 199 |
# File 'lib/aws-sdk-iam/saml_provider.rb', line 195 def delete( = {}) = .merge(saml_provider_arn: @arn) resp = @client.delete_saml_provider() resp.data 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.
223 224 225 |
# File 'lib/aws-sdk-iam/saml_provider.rb', line 223 def identifiers { arn: @arn } end |
#load ⇒ self Also known as: reload
Loads, or reloads #data for the current Aws::IAM::SamlProvider. Returns ‘self` making it possible to chain methods.
saml_provider.reload.data
69 70 71 72 73 |
# File 'lib/aws-sdk-iam/saml_provider.rb', line 69 def load resp = @client.get_saml_provider(saml_provider_arn: @arn) @data = resp.data self end |
#saml_metadata_document ⇒ String
The XML metadata document that includes information about an identity provider.
40 41 42 |
# File 'lib/aws-sdk-iam/saml_provider.rb', line 40 def data[:saml_metadata_document] end |
#update(options = {}) ⇒ Types::UpdateSAMLProviderResponse
215 216 217 218 219 |
# File 'lib/aws-sdk-iam/saml_provider.rb', line 215 def update( = {}) = .merge(saml_provider_arn: @arn) resp = @client.update_saml_provider() resp.data end |
#valid_until ⇒ Time
The expiration date and time for the SAML provider.
52 53 54 |
# File 'lib/aws-sdk-iam/saml_provider.rb', line 52 def valid_until data[:valid_until] 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
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 |
# File 'lib/aws-sdk-iam/saml_provider.rb', line 171 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 |