com.amazonaws.services.cognitoidentityprovider.model

Class UpdateIdentityProviderRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentityprovider.model.UpdateIdentityProviderRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class UpdateIdentityProviderRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable

Updates IdP information for a user pool.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

• Signing Amazon Web Services API Requests

• Using the Amazon Cognito user pools API and user pool endpoints

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UpdateIdentityProviderRequest()

Method Summary

Modifier and Type	Method and Description
UpdateIdentityProviderRequest	addAttributeMappingEntry(java.lang.String key, java.lang.String value) The IdP attribute mapping to be changed.
UpdateIdentityProviderRequest	addProviderDetailsEntry(java.lang.String key, java.lang.String value) The IdP details to be updated, such as MetadataURL and MetadataFile.
UpdateIdentityProviderRequest	clearAttributeMappingEntries() Removes all the entries added into AttributeMapping.
UpdateIdentityProviderRequest	clearProviderDetailsEntries() Removes all the entries added into ProviderDetails.
boolean	equals(java.lang.Object obj)
java.util.Map<java.lang.String,java.lang.String>	getAttributeMapping() The IdP attribute mapping to be changed.
java.util.List<java.lang.String>	getIdpIdentifiers() A list of IdP identifiers.
java.util.Map<java.lang.String,java.lang.String>	getProviderDetails() The IdP details to be updated, such as MetadataURL and MetadataFile.
java.lang.String	getProviderName() The IdP name.
java.lang.String	getUserPoolId() The user pool ID.
int	hashCode()
void	setAttributeMapping(java.util.Map<java.lang.String,java.lang.String> attributeMapping) The IdP attribute mapping to be changed.
void	setIdpIdentifiers(java.util.Collection<java.lang.String> idpIdentifiers) A list of IdP identifiers.
void	setProviderDetails(java.util.Map<java.lang.String,java.lang.String> providerDetails) The IdP details to be updated, such as MetadataURL and MetadataFile.
void	setProviderName(java.lang.String providerName) The IdP name.
void	setUserPoolId(java.lang.String userPoolId) The user pool ID.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
UpdateIdentityProviderRequest	withAttributeMapping(java.util.Map<java.lang.String,java.lang.String> attributeMapping) The IdP attribute mapping to be changed.
UpdateIdentityProviderRequest	withIdpIdentifiers(java.util.Collection<java.lang.String> idpIdentifiers) A list of IdP identifiers.
UpdateIdentityProviderRequest	withIdpIdentifiers(java.lang.String... idpIdentifiers) A list of IdP identifiers.
UpdateIdentityProviderRequest	withProviderDetails(java.util.Map<java.lang.String,java.lang.String> providerDetails) The IdP details to be updated, such as MetadataURL and MetadataFile.
UpdateIdentityProviderRequest	withProviderName(java.lang.String providerName) The IdP name.
UpdateIdentityProviderRequest	withUserPoolId(java.lang.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

UpdateIdentityProviderRequest

public UpdateIdentityProviderRequest()

Method Detail

getUserPoolId

public java.lang.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(java.lang.String userPoolId)

The user pool ID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Parameters:

userPoolId -

The user pool ID.

withUserPoolId

public UpdateIdentityProviderRequest withUserPoolId(java.lang.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 java.lang.String getProviderName()

The IdP name.

Constraints:
Length: 1 - 32
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Returns:

The IdP name.

setProviderName

public void setProviderName(java.lang.String providerName)

The IdP name.

Constraints:
Length: 1 - 32
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Parameters:

providerName -

The IdP name.

withProviderName

public UpdateIdentityProviderRequest withProviderName(java.lang.String providerName)

The IdP 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 IdP name.

Returns:

A reference to this updated object so that method calls can be chained together.

getProviderDetails

public java.util.Map<java.lang.String,java.lang.String> getProviderDetails()

The IdP details to be updated, such as MetadataURL and MetadataFile.

Returns:

The IdP details to be updated, such as MetadataURL and MetadataFile.

setProviderDetails

public void setProviderDetails(java.util.Map<java.lang.String,java.lang.String> providerDetails)

The IdP details to be updated, such as MetadataURL and MetadataFile.

Parameters:

providerDetails -

The IdP details to be updated, such as MetadataURL and MetadataFile.

withProviderDetails

public UpdateIdentityProviderRequest withProviderDetails(java.util.Map<java.lang.String,java.lang.String> providerDetails)

The IdP details to be updated, such as MetadataURL and MetadataFile.

Returns a reference to this object so that method calls can be chained together.

Parameters:

providerDetails -

The IdP details to be updated, such as MetadataURL and MetadataFile.

Returns:

A reference to this updated object so that method calls can be chained together.

addProviderDetailsEntry

public UpdateIdentityProviderRequest addProviderDetailsEntry(java.lang.String key,
                                                             java.lang.String value)

The IdP details to be updated, 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 UpdateIdentityProviderRequest clearProviderDetailsEntries()

Removes all the entries added into ProviderDetails.

Returns a reference to this object so that method calls can be chained together.

getAttributeMapping

public java.util.Map<java.lang.String,java.lang.String> getAttributeMapping()

The IdP attribute mapping to be changed.

Returns:

The IdP attribute mapping to be changed.

setAttributeMapping

public void setAttributeMapping(java.util.Map<java.lang.String,java.lang.String> attributeMapping)

The IdP attribute mapping to be changed.

Parameters:

attributeMapping -

The IdP attribute mapping to be changed.

withAttributeMapping

public UpdateIdentityProviderRequest withAttributeMapping(java.util.Map<java.lang.String,java.lang.String> attributeMapping)

The IdP attribute mapping to be changed.

Returns a reference to this object so that method calls can be chained together.

Parameters:

attributeMapping -

The IdP attribute mapping to be changed.

Returns:

A reference to this updated object so that method calls can be chained together.

addAttributeMappingEntry

public UpdateIdentityProviderRequest addAttributeMappingEntry(java.lang.String key,
                                                              java.lang.String value)

The IdP attribute mapping to be changed.

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 UpdateIdentityProviderRequest clearAttributeMappingEntries()

Removes all the entries added into AttributeMapping.

Returns a reference to this object so that method calls can be chained together.

getIdpIdentifiers

public java.util.List<java.lang.String> getIdpIdentifiers()

A list of IdP identifiers.

Returns:

A list of IdP identifiers.

setIdpIdentifiers

public void setIdpIdentifiers(java.util.Collection<java.lang.String> idpIdentifiers)

A list of IdP identifiers.

Parameters:

idpIdentifiers -

A list of IdP identifiers.

withIdpIdentifiers

public UpdateIdentityProviderRequest withIdpIdentifiers(java.lang.String... idpIdentifiers)

A list of IdP identifiers.

Returns a reference to this object so that method calls can be chained together.

Parameters:

idpIdentifiers -

A list of IdP identifiers.

Returns:

A reference to this updated object so that method calls can be chained together.

withIdpIdentifiers

public UpdateIdentityProviderRequest withIdpIdentifiers(java.util.Collection<java.lang.String> idpIdentifiers)

A list of IdP identifiers.

Returns a reference to this object so that method calls can be chained together.

Parameters:

idpIdentifiers -

A list of IdP identifiers.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object