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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-iam/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#name ⇒ String

The name of the provider to create.

This parameter allows (through 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) 


1406
1407
1408
1409
1410
1411
1412
 
# File 'lib/aws-sdk-iam/types.rb', line 1406

class CreateSAMLProviderRequest < Struct.new(
  :saml_metadata_document,
  :name,
  :tags)
  SENSITIVE = []
  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) 


1406
1407
1408
1409
1410
1411
1412
 
# File 'lib/aws-sdk-iam/types.rb', line 1406

class CreateSAMLProviderRequest < Struct.new(
  :saml_metadata_document,
  :name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

A list of tags that you want to attach to the new IAM SAML provider. Each tag consists of a key name and an associated value. For more information about tagging, see [Tagging IAM resources] in the *IAM User Guide*.

<note markdown=“1”> If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

</note>

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

Returns:



1406
1407
1408
1409
1410
1411
1412
 
# File 'lib/aws-sdk-iam/types.rb', line 1406

class CreateSAMLProviderRequest < Struct.new(
  :saml_metadata_document,
  :name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end