Class: Aws::IAM::SamlProvider

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

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Actions collapse

Instance Method Summary collapse

Constructor Details

#initialize(arn, options = {}) ⇒ SamlProvider #initialize(options = {}) ⇒ SamlProvider

Returns a new instance of SamlProvider.

Overloads:

  • #initialize(arn, options = {}) ⇒ SamlProvider

    Parameters:

    • arn (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ SamlProvider

    Options Hash (options):

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


22
23
24
25
26
27
28
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/saml_provider.rb', line 22

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

Instance Method Details

#arn ⇒ String

Returns:

  • (String) 


33
34
35
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/saml_provider.rb', line 33

def arn
  @arn
end

#client ⇒ Client

Returns:



71
72
73
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/saml_provider.rb', line 71

def client
  @client
end

#create_date ⇒ Time

The date and time when the SAML provider was created.

Returns:

  • (Time) 


46
47
48
 
# File 'gems/aws-sdk-iam/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.

Returns:



93
94
95
96
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/saml_provider.rb', line 93

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.



101
102
103
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/saml_provider.rb', line 101

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


saml_provider.delete()

Parameters:

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

    ({})

Returns:

  • (EmptyStructure) 


211
212
213
214
215
216
217
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/saml_provider.rb', line 211

def delete(options = {})
  options = options.merge(saml_provider_arn: @arn)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.delete_saml_provider(options)
  end
  resp.data
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

Returns:

  • (self) 


81
82
83
84
85
86
87
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/saml_provider.rb', line 81

def load
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.get_saml_provider(saml_provider_arn: @arn)
  end
  @data = resp.data
  self
end

#saml_metadata_document ⇒ String

The XML metadata document that includes information about an identity provider.

Returns:

  • (String) 


40
41
42
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/saml_provider.rb', line 40

def saml_metadata_document
  data[:saml_metadata_document]
end

#tags ⇒ Array<Types::Tag>

A list of tags that are attached to the specified IAM SAML provider. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

Returns:



64
65
66
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/saml_provider.rb', line 64

def tags
  data[:tags]
end

#update(options = {}) ⇒ Types::UpdateSAMLProviderResponse

Examples:

Request syntax with placeholder values


saml_provider.update({
  saml_metadata_document: "SAMLMetadataDocumentType", # required
})

Parameters:

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

    ({})

Options Hash (options):

  • :saml_metadata_document (required, String) —

    An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP.

Returns:



233
234
235
236
237
238
239
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/saml_provider.rb', line 233

def update(options = {})
  options = options.merge(saml_provider_arn: @arn)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.update_saml_provider(options)
  end
  resp.data
end

#valid_until ⇒ Time

The expiration date and time for the SAML provider.

Returns:

  • (Time) 


52
53
54
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/saml_provider.rb', line 52

def valid_until
  data[:valid_until]
end

#wait_until(options = {}) {|resource| ... } ⇒ 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) 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

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

Yield Parameters:

  • resource (Resource) —

    to be used in the waiting condition.

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



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/saml_provider.rb', line 185

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::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    Aws::Waiters::Waiter.new(options).wait({})
  end
end