Class: Aws::IAM::Types::CreateSAMLProviderRequest

Inherits:

Struct

• Object
• Struct
• Aws::IAM::Types::CreateSAMLProviderRequest

Includes:

Structure

Defined in:

lib/aws-sdk-iam/types.rb

Overview

Note:

When making an API call, you may pass CreateSAMLProviderRequest data as a hash:

{
  saml_metadata_document: "SAMLMetadataDocumentType", # required
  name: "SAMLProviderNameType", # required
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #name ⇒ String

  The name of the provider to create.

• #saml_metadata_document ⇒ String

  An XML document generated by an identity provider (IdP) that supports SAML 2.0.

Instance Attribute Details

#name ⇒ String

The name of the provider to create.

This parameter allows (per its [regex pattern]) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

[1]: wikipedia.org/wiki/regex

Returns:

• (String)

# File 'lib/aws-sdk-iam/types.rb', line 1236

class CreateSAMLProviderRequest < Struct.new(
  :saml_metadata_document,
  :name)
  include Aws::Structure
end

#saml_metadata_document ⇒ 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.

For more information, see [About SAML 2.0-based Federation] in the *IAM User Guide*

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html

Returns:

• (String)

# File 'lib/aws-sdk-iam/types.rb', line 1236

class CreateSAMLProviderRequest < Struct.new(
  :saml_metadata_document,
  :name)
  include Aws::Structure
end