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

Class: Aws::CognitoIdentityProvider::Types::CreateIdentityProviderRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateIdentityProviderRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  user_pool_id: "UserPoolIdType", # required
  provider_name: "ProviderNameTypeV1", # required
  provider_type: "SAML", # required, accepts SAML, Facebook, Google, LoginWithAmazon
  provider_details: { # required
    "StringType" => "StringType",
  },
  attribute_mapping: {
    "AttributeMappingKeyType" => "StringType",
  },
  idp_identifiers: ["IdpIdentifierType"],
}

Instance Attribute Summary collapse

Instance Attribute Details

#attribute_mappingHash<String,String>

A mapping of identity provider attributes to standard and custom user pool attributes.

Returns:

  • (Hash<String,String>)

    A mapping of identity provider attributes to standard and custom user pool attributes.

#idp_identifiersArray<String>

A list of identity provider identifiers.

Returns:

  • (Array<String>)

    A list of identity provider identifiers.

#provider_detailsHash<String,String>

The identity provider details, such as MetadataURL and MetadataFile.

Returns:

  • (Hash<String,String>)

    The identity provider details, such as MetadataURL and MetadataFile.

#provider_nameString

The identity provider name.

Returns:

  • (String)

    The identity provider name.

#provider_typeString

The identity provider type.

Possible values:

  • SAML
  • Facebook
  • Google
  • LoginWithAmazon

Returns:

  • (String)

    The identity provider type.

#user_pool_idString

The user pool ID.

Returns:

  • (String)

    The user pool ID.