CreateIdentityProviderRequest (AWS SDK for Android - Amazon Cognito Identity Provider 2.16.8 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.cognitoidentityprovider.model.CreateIdentityProviderRequest

All Implemented Interfaces:

Serializable, Cloneable
```
public class CreateIdentityProviderRequest
extends AmazonWebServiceRequest
implements Serializable
```
Creates an identity provider for a user pool.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

CreateIdentityProviderRequest()

Constructors
Constructor and Description
`CreateIdentityProviderRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateIdentityProviderRequest`	`addAttributeMappingEntry(String key, String value)` A mapping of identity provider attributes to standard and custom user pool attributes.
`CreateIdentityProviderRequest`	`addProviderDetailsEntry(String key, String value)` The identity provider details, such as `MetadataURL` and `MetadataFile`.
`CreateIdentityProviderRequest`	`clearAttributeMappingEntries()` Removes all the entries added into AttributeMapping.
`CreateIdentityProviderRequest`	`clearProviderDetailsEntries()` Removes all the entries added into ProviderDetails.
`boolean`	`equals(Object obj)`
`Map<String,String>`	`getAttributeMapping()` A mapping of identity provider attributes to standard and custom user pool attributes.
`List<String>`	`getIdpIdentifiers()` A list of identity provider identifiers.
`Map<String,String>`	`getProviderDetails()` The identity provider details, such as `MetadataURL` and `MetadataFile`.
`String`	`getProviderName()` The identity provider name.
`String`	`getProviderType()` The identity provider type.
`String`	`getUserPoolId()` The user pool ID.
`int`	`hashCode()`
`void`	`setAttributeMapping(Map<String,String> attributeMapping)` A mapping of identity provider attributes to standard and custom user pool attributes.
`void`	`setIdpIdentifiers(Collection<String> idpIdentifiers)` A list of identity provider identifiers.
`void`	`setProviderDetails(Map<String,String> providerDetails)` The identity provider details, such as `MetadataURL` and `MetadataFile`.
`void`	`setProviderName(String providerName)` The identity provider name.
`void`	`setProviderType(IdentityProviderTypeType providerType)` The identity provider type.
`void`	`setProviderType(String providerType)` The identity provider type.
`void`	`setUserPoolId(String userPoolId)` The user pool ID.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`CreateIdentityProviderRequest`	`withAttributeMapping(Map<String,String> attributeMapping)` A mapping of identity provider attributes to standard and custom user pool attributes.
`CreateIdentityProviderRequest`	`withIdpIdentifiers(Collection<String> idpIdentifiers)` A list of identity provider identifiers.
`CreateIdentityProviderRequest`	`withIdpIdentifiers(String... idpIdentifiers)` A list of identity provider identifiers.
`CreateIdentityProviderRequest`	`withProviderDetails(Map<String,String> providerDetails)` The identity provider details, such as `MetadataURL` and `MetadataFile`.
`CreateIdentityProviderRequest`	`withProviderName(String providerName)` The identity provider name.
`CreateIdentityProviderRequest`	`withProviderType(IdentityProviderTypeType providerType)` The identity provider type.
`CreateIdentityProviderRequest`	`withProviderType(String providerType)` The identity provider type.
`CreateIdentityProviderRequest`	`withUserPoolId(String userPoolId)` The user pool ID.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreateIdentityProviderRequest
```
public CreateIdentityProviderRequest()
```
- Method Detail
  - getUserPoolId
```
public String getUserPoolId()
```
    The user pool ID.
    
    Constraints:
    Length: 1 - 55
    Pattern: [\w-]+_[0-9a-zA-Z]+
    
    Returns:
    
    The user pool ID.
  - setUserPoolId
```
public void setUserPoolId(String userPoolId)
```
    The user pool ID.
    
    Constraints:
    Length: 1 - 55
    Pattern: [\w-]+_[0-9a-zA-Z]+
    
    Parameters:
    
    userPoolId -
    The user pool ID.
  - withUserPoolId
```
public CreateIdentityProviderRequest withUserPoolId(String userPoolId)
```
    The user pool ID.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 55
    Pattern: [\w-]+_[0-9a-zA-Z]+
    
    Parameters:
    
    userPoolId -
    The user pool ID.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getProviderName
```
public String getProviderName()
```
    The identity provider name.
    
    Constraints:
    Length: 1 - 32
    Pattern: [^_][\p{L}\p{M}\p{S}\p{N}\p{P}][^_]+
    
    Returns:
    
    The identity provider name.
  - setProviderName
```
public void setProviderName(String providerName)
```
    The identity provider name.
    
    Constraints:
    Length: 1 - 32
    Pattern: [^_][\p{L}\p{M}\p{S}\p{N}\p{P}][^_]+
    
    Parameters:
    
    providerName -
    The identity provider name.
  - withProviderName
```
public CreateIdentityProviderRequest withProviderName(String providerName)
```
    The identity provider name.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 32
    Pattern: [^_][\p{L}\p{M}\p{S}\p{N}\p{P}][^_]+
    
    Parameters:
    
    providerName -
    The identity provider name.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getProviderType
```
public String getProviderType()
```
    The identity provider type.
    
    Constraints:
    Allowed Values: SAML, Facebook, Google, LoginWithAmazon, SignInWithApple, OIDC
    
    Returns:
    
    The identity provider type.
    
    See Also:
    
    IdentityProviderTypeType
  - setProviderType
```
public void setProviderType(String providerType)
```
    The identity provider type.
    
    Constraints:
    Allowed Values: SAML, Facebook, Google, LoginWithAmazon, SignInWithApple, OIDC
    
    Parameters:
    
    providerType -
    The identity provider type.
    
    See Also:
    
    IdentityProviderTypeType
  - withProviderType
```
public CreateIdentityProviderRequest withProviderType(String providerType)
```
    The identity provider type.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: SAML, Facebook, Google, LoginWithAmazon, SignInWithApple, OIDC
    
    Parameters:
    
    providerType -
    The identity provider type.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    IdentityProviderTypeType
  - setProviderType
```
public void setProviderType(IdentityProviderTypeType providerType)
```
    The identity provider type.
    
    Constraints:
    Allowed Values: SAML, Facebook, Google, LoginWithAmazon, SignInWithApple, OIDC
    
    Parameters:
    
    providerType -
    The identity provider type.
    
    See Also:
    
    IdentityProviderTypeType
  - withProviderType
```
public CreateIdentityProviderRequest withProviderType(IdentityProviderTypeType providerType)
```
    The identity provider type.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: SAML, Facebook, Google, LoginWithAmazon, SignInWithApple, OIDC
    
    Parameters:
    
    providerType -
    The identity provider type.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    IdentityProviderTypeType
  - getProviderDetails
```
public Map<String,String> getProviderDetails()
```
    The identity provider details, such as MetadataURL and MetadataFile.
    
    Returns:
    
    The identity provider details, such as MetadataURL and MetadataFile.
  - setProviderDetails
```
public void setProviderDetails(Map<String,String> providerDetails)
```
    The identity provider details, such as MetadataURL and MetadataFile.
    
    Parameters:
    
    providerDetails -
    The identity provider details, such as MetadataURL and MetadataFile.
  - withProviderDetails
```
public CreateIdentityProviderRequest withProviderDetails(Map<String,String> providerDetails)
```
    The identity provider details, such as MetadataURL and MetadataFile.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    providerDetails -
    The identity provider details, such as MetadataURL and MetadataFile.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addProviderDetailsEntry
```
public CreateIdentityProviderRequest addProviderDetailsEntry(String key,
                                                             String value)
```
    The identity provider details, such as MetadataURL and MetadataFile.
    
    The method adds a new key-value pair into ProviderDetails parameter, and returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    key - The key of the entry to be added into ProviderDetails.
    
    value - The corresponding value of the entry to be added into ProviderDetails.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - clearProviderDetailsEntries
```
public CreateIdentityProviderRequest clearProviderDetailsEntries()
```
    Removes all the entries added into ProviderDetails.
    Returns a reference to this object so that method calls can be chained together.
  - getAttributeMapping
```
public Map<String,String> getAttributeMapping()
```
    A mapping of identity provider attributes to standard and custom user pool attributes.
    
    Returns:
    
    A mapping of identity provider attributes to standard and custom user pool attributes.
  - setAttributeMapping
```
public void setAttributeMapping(Map<String,String> attributeMapping)
```
    A mapping of identity provider attributes to standard and custom user pool attributes.
    
    Parameters:
    
    attributeMapping -
    A mapping of identity provider attributes to standard and custom user pool attributes.
  - withAttributeMapping
```
public CreateIdentityProviderRequest withAttributeMapping(Map<String,String> attributeMapping)
```
    A mapping of identity provider attributes to standard and custom user pool attributes.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    attributeMapping -
    A mapping of identity provider attributes to standard and custom user pool attributes.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addAttributeMappingEntry
```
public CreateIdentityProviderRequest addAttributeMappingEntry(String key,
                                                              String value)
```
    A mapping of identity provider attributes to standard and custom user pool attributes.
    
    The method adds a new key-value pair into AttributeMapping parameter, and returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    key - The key of the entry to be added into AttributeMapping.
    
    value - The corresponding value of the entry to be added into AttributeMapping.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - clearAttributeMappingEntries
```
public CreateIdentityProviderRequest clearAttributeMappingEntries()
```
    Removes all the entries added into AttributeMapping.
    Returns a reference to this object so that method calls can be chained together.
  - getIdpIdentifiers
```
public List<String> getIdpIdentifiers()
```
    A list of identity provider identifiers.
    
    Returns:
    
    A list of identity provider identifiers.
  - setIdpIdentifiers
```
public void setIdpIdentifiers(Collection<String> idpIdentifiers)
```
    A list of identity provider identifiers.
    
    Parameters:
    
    idpIdentifiers -
    A list of identity provider identifiers.
  - withIdpIdentifiers
```
public CreateIdentityProviderRequest withIdpIdentifiers(String... idpIdentifiers)
```
    A list of identity provider identifiers.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    idpIdentifiers -
    A list of identity provider identifiers.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withIdpIdentifiers
```
public CreateIdentityProviderRequest withIdpIdentifiers(Collection<String> idpIdentifiers)
```
    A list of identity provider identifiers.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    idpIdentifiers -
    A list of identity provider identifiers.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class CreateIdentityProviderRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateIdentityProviderRequest

Method Detail

getUserPoolId

setUserPoolId

withUserPoolId

getProviderName

setProviderName

withProviderName

getProviderType

setProviderType

withProviderType

setProviderType

withProviderType

getProviderDetails

setProviderDetails

withProviderDetails

addProviderDetailsEntry

clearProviderDetailsEntries

getAttributeMapping

setAttributeMapping

withAttributeMapping

addAttributeMappingEntry

clearAttributeMappingEntries

getIdpIdentifiers

setIdpIdentifiers

withIdpIdentifiers

withIdpIdentifiers

toString

hashCode

equals