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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

Note:

When making an API call, you may pass CreateIdentityProviderRequest data as a 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>)


2429
2430
2431
2432
2433
2434
2435
2436
2437
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2429

class CreateIdentityProviderRequest < Struct.new(
  :user_pool_id,
  :provider_name,
  :provider_type,
  :provider_details,
  :attribute_mapping,
  :idp_identifiers)
  include Aws::Structure
end

#idp_identifiersArray<String>

A list of identity provider identifiers.

Returns:

  • (Array<String>)


2429
2430
2431
2432
2433
2434
2435
2436
2437
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2429

class CreateIdentityProviderRequest < Struct.new(
  :user_pool_id,
  :provider_name,
  :provider_type,
  :provider_details,
  :attribute_mapping,
  :idp_identifiers)
  include Aws::Structure
end

#provider_detailsHash<String,String>

The identity provider details, such as MetadataURL and MetadataFile.

Returns:

  • (Hash<String,String>)


2429
2430
2431
2432
2433
2434
2435
2436
2437
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2429

class CreateIdentityProviderRequest < Struct.new(
  :user_pool_id,
  :provider_name,
  :provider_type,
  :provider_details,
  :attribute_mapping,
  :idp_identifiers)
  include Aws::Structure
end

#provider_nameString

The identity provider name.

Returns:

  • (String)


2429
2430
2431
2432
2433
2434
2435
2436
2437
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2429

class CreateIdentityProviderRequest < Struct.new(
  :user_pool_id,
  :provider_name,
  :provider_type,
  :provider_details,
  :attribute_mapping,
  :idp_identifiers)
  include Aws::Structure
end

#provider_typeString

The identity provider type.

Returns:

  • (String)


2429
2430
2431
2432
2433
2434
2435
2436
2437
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2429

class CreateIdentityProviderRequest < Struct.new(
  :user_pool_id,
  :provider_name,
  :provider_type,
  :provider_details,
  :attribute_mapping,
  :idp_identifiers)
  include Aws::Structure
end

#user_pool_idString

The user pool ID.

Returns:

  • (String)


2429
2430
2431
2432
2433
2434
2435
2436
2437
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2429

class CreateIdentityProviderRequest < Struct.new(
  :user_pool_id,
  :provider_name,
  :provider_type,
  :provider_details,
  :attribute_mapping,
  :idp_identifiers)
  include Aws::Structure
end