You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Actions collapse

Read-Only Attributes 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)


19
20
21
22
23
24
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/saml_provider.rb', line 19

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)
end

Instance Method Details

#arnString

Returns:

  • (String)


29
30
31
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/saml_provider.rb', line 29

def arn
  @arn
end

#clientClient

Returns:



55
56
57
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/saml_provider.rb', line 55

def client
  @client
end

#create_dateTime

The date and time when the SAML provider was created.

Returns:

  • (Time)


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

def create_date
  data.create_date
end

#dataTypes::GetSAMLProviderResponse

Returns the data for this Aws::IAM::SamlProvider. Calls Client#get_saml_provider if #data_loaded? is false.

Returns:



75
76
77
78
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/saml_provider.rb', line 75

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.



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

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


saml_provider.delete()

Parameters:

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

    ({})

Returns:

  • (EmptyStructure)


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

def delete(options = {})
  options = options.merge(saml_provider_arn: @arn)
  resp = @client.delete_saml_provider(options)
  resp.data
end

#loadself 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)


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

def load
  resp = @client.get_saml_provider(saml_provider_arn: @arn)
  @data = resp.data
  self
end

#saml_metadata_documentString

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

Returns:

  • (String)


36
37
38
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/saml_provider.rb', line 36

def 
  data.
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:



114
115
116
117
118
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/saml_provider.rb', line 114

def update(options = {})
  options = options.merge(saml_provider_arn: @arn)
  resp = @client.update_saml_provider(options)
  resp.data
end

#valid_untilTime

The expiration date and time for the SAML provider.

Returns:

  • (Time)


48
49
50
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/saml_provider.rb', line 48

def valid_until
  data.valid_until
end