AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Class: Aws::IAM::SamlProvider

Inherits:
Resources::Resource show all
Defined in:
(unknown)

Instance Attribute Summary collapse

Attributes inherited from Resources::Resource

#client, #identifiers

Instance Method Summary collapse

Methods inherited from Resources::Resource

add_data_attribute, add_identifier, #data, data_attributes, #data_loaded?, identifiers, #load, #wait_until

Methods included from Resources::OperationMethods

#add_batch_operation, #add_operation, #batch_operation, #batch_operation_names, #batch_operations, #operation, #operation_names, #operations

Constructor Details

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

Overloads:

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

    Parameters:

    • arn (String)

    Options Hash (options):

    • :client (Client)

      When `:client is not given, the options hash is used to construct a new Client object.

  • #initialize(options = {}) ⇒ Object

    Options Hash (options):

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

      When `:client is not given, the options hash is used to construct a new Client object.

Instance Attribute Details

#arnString (readonly)

Returns:

  • (String)

#create_dateTime (readonly)

The date and time when the SAML provider was created.

Returns:

  • (Time)

    The date and time when the SAML provider was created.

#saml_metadata_documentString (readonly)

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

Returns:

  • (String)

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

#valid_untilTime (readonly)

The expiration date and time for the SAML provider.

Returns:

  • (Time)

    The expiration date and time for the SAML provider.

Instance Method Details

#deleteStruct

Deletes a SAML provider resource in IAM.

Deleting the provider resource from IAM does not update any roles that reference the SAML provider resource's ARN as a principal in their trust policies. Any attempt to assume a role that references a non-existent provider resource ARN fails.

This operation requires Signature Version 4.

Examples:

Request syntax example with placeholder values


samlprovider.delete()

Returns:

  • (Struct)

    Returns an empty response.

See Also:

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

Updates the metadata document for an existing SAML provider resource object.

This operation requires Signature Version 4.

Examples:

Request syntax example with placeholder values


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

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:

See Also: