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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iam/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
}

Instance Attribute Summary collapse

Instance Attribute Details

#nameString

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: =,.@-

Returns:

  • (String)


1157
1158
1159
1160
1161
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 1157

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

#saml_metadata_documentString

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

Returns:

  • (String)


1157
1158
1159
1160
1161
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 1157

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