com.amazonaws.services.cognitoidp.model

Class CreateIdentityProviderRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidp.model.CreateIdentityProviderRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateIdentityProviderRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateIdentityProviderRequest()

Method Summary

Modifier and Type	Method and Description
CreateIdentityProviderRequest	addAttributeMappingEntry(String key, String value) Add a single AttributeMapping entry
CreateIdentityProviderRequest	addProviderDetailsEntry(String key, String value) Add a single ProviderDetails entry
CreateIdentityProviderRequest	clearAttributeMappingEntries() Removes all the entries added into AttributeMapping.
CreateIdentityProviderRequest	clearProviderDetailsEntries() Removes all the entries added into ProviderDetails.
CreateIdentityProviderRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Map<String,String>	getAttributeMapping() A mapping of IdP attributes to standard and custom user pool attributes.
List<String>	getIdpIdentifiers() A list of IdP identifiers.
Map<String,String>	getProviderDetails() The IdP details.
String	getProviderName() The IdP name.
String	getProviderType() The IdP type.
String	getUserPoolId() The user pool ID.
int	hashCode()
void	setAttributeMapping(Map<String,String> attributeMapping) A mapping of IdP attributes to standard and custom user pool attributes.
void	setIdpIdentifiers(Collection<String> idpIdentifiers) A list of IdP identifiers.
void	setProviderDetails(Map<String,String> providerDetails) The IdP details.
void	setProviderName(String providerName) The IdP name.
void	setProviderType(IdentityProviderTypeType providerType) The IdP type.
void	setProviderType(String providerType) The IdP type.
void	setUserPoolId(String userPoolId) The user pool ID.
String	toString() Returns a string representation of this object.
CreateIdentityProviderRequest	withAttributeMapping(Map<String,String> attributeMapping) A mapping of IdP attributes to standard and custom user pool attributes.
CreateIdentityProviderRequest	withIdpIdentifiers(Collection<String> idpIdentifiers) A list of IdP identifiers.
CreateIdentityProviderRequest	withIdpIdentifiers(String... idpIdentifiers) A list of IdP identifiers.
CreateIdentityProviderRequest	withProviderDetails(Map<String,String> providerDetails) The IdP details.
CreateIdentityProviderRequest	withProviderName(String providerName) The IdP name.
CreateIdentityProviderRequest	withProviderType(IdentityProviderTypeType providerType) The IdP type.
CreateIdentityProviderRequest	withProviderType(String providerType) The IdP type.
CreateIdentityProviderRequest	withUserPoolId(String userPoolId) The user pool ID.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateIdentityProviderRequest

public CreateIdentityProviderRequest()

Method Detail

setUserPoolId

public void setUserPoolId(String userPoolId)

The user pool ID.

Parameters:

userPoolId - The user pool ID.

getUserPoolId

public String getUserPoolId()

The user pool ID.

Returns:

The user pool ID.

withUserPoolId

public CreateIdentityProviderRequest withUserPoolId(String userPoolId)

The user pool ID.

Parameters:

userPoolId - The user pool ID.

Returns:

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

setProviderName

public void setProviderName(String providerName)

The IdP name.

Parameters:

providerName - The IdP name.

getProviderName

public String getProviderName()

The IdP name.

Returns:

The IdP name.

withProviderName

public CreateIdentityProviderRequest withProviderName(String providerName)

The IdP name.

Parameters:

providerName - The IdP name.

Returns:

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

setProviderType

public void setProviderType(String providerType)

The IdP type.

Parameters:

providerType - The IdP type.

See Also:

IdentityProviderTypeType

getProviderType

public String getProviderType()

The IdP type.

Returns:

The IdP type.

See Also:

IdentityProviderTypeType

withProviderType

public CreateIdentityProviderRequest withProviderType(String providerType)

The IdP type.

Parameters:

providerType - The IdP type.

Returns:

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

See Also:

IdentityProviderTypeType

setProviderType

public void setProviderType(IdentityProviderTypeType providerType)

The IdP type.

Parameters:

providerType - The IdP type.

See Also:

IdentityProviderTypeType

withProviderType

public CreateIdentityProviderRequest withProviderType(IdentityProviderTypeType providerType)

The IdP type.

Parameters:

providerType - The IdP type.

Returns:

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

See Also:

IdentityProviderTypeType

getProviderDetails

public Map<String,String> getProviderDetails()

The IdP details. The following list describes the provider detail keys for each IdP type.

• For Google and Login with Amazon:

  • client_id

  • client_secret

  • authorize_scopes

• For Facebook:

  • client_id

  • client_secret

  • authorize_scopes

  • api_version

• For Sign in with Apple:

  • client_id

  • team_id

  • key_id

  • private_key

  • authorize_scopes

• For OpenID Connect (OIDC) providers:

  • client_id

  • client_secret

  • attributes_request_method

  • oidc_issuer

  • authorize_scopes

  • The following keys are only present if Amazon Cognito didn't discover them at the oidc_issuer URL.

    • authorize_url

    • token_url

    • attributes_url

    • jwks_uri

  • Amazon Cognito sets the value of the following keys automatically. They are read-only.

    • attributes_url_add_attributes

• For SAML providers:

  • MetadataFile or MetadataURL

  • IDPSignout optional

Returns:

The IdP details. The following list describes the provider detail keys for each IdP type.

• For Google and Login with Amazon:

  • client_id

  • client_secret

  • authorize_scopes

• For Facebook:

  • client_id

  • client_secret

  • authorize_scopes

  • api_version

• For Sign in with Apple:

  • client_id

  • team_id

  • key_id

  • private_key

  • authorize_scopes

• For OpenID Connect (OIDC) providers:

  • client_id

  • client_secret

  • attributes_request_method

  • oidc_issuer

  • authorize_scopes

  • The following keys are only present if Amazon Cognito didn't discover them at the oidc_issuer URL.

    • authorize_url

    • token_url

    • attributes_url

    • jwks_uri

  • Amazon Cognito sets the value of the following keys automatically. They are read-only.

    • attributes_url_add_attributes

• For SAML providers:

  • MetadataFile or MetadataURL

  • IDPSignout optional

setProviderDetails

public void setProviderDetails(Map<String,String> providerDetails)

The IdP details. The following list describes the provider detail keys for each IdP type.

• For Google and Login with Amazon:

  • client_id

  • client_secret

  • authorize_scopes

• For Facebook:

  • client_id

  • client_secret

  • authorize_scopes

  • api_version

• For Sign in with Apple:

  • client_id

  • team_id

  • key_id

  • private_key

  • authorize_scopes

• For OpenID Connect (OIDC) providers:

  • client_id

  • client_secret

  • attributes_request_method

  • oidc_issuer

  • authorize_scopes

  • The following keys are only present if Amazon Cognito didn't discover them at the oidc_issuer URL.

    • authorize_url

    • token_url

    • attributes_url

    • jwks_uri

  • Amazon Cognito sets the value of the following keys automatically. They are read-only.

    • attributes_url_add_attributes

• For SAML providers:

  • MetadataFile or MetadataURL

  • IDPSignout optional

Parameters:

providerDetails - The IdP details. The following list describes the provider detail keys for each IdP type.

• For Google and Login with Amazon:

  • client_id

  • client_secret

  • authorize_scopes

• For Facebook:

  • client_id

  • client_secret

  • authorize_scopes

  • api_version

• For Sign in with Apple:

  • client_id

  • team_id

  • key_id

  • private_key

  • authorize_scopes

• For OpenID Connect (OIDC) providers:

  • client_id

  • client_secret

  • attributes_request_method

  • oidc_issuer

  • authorize_scopes

  • The following keys are only present if Amazon Cognito didn't discover them at the oidc_issuer URL.

    • authorize_url

    • token_url

    • attributes_url

    • jwks_uri

  • Amazon Cognito sets the value of the following keys automatically. They are read-only.

    • attributes_url_add_attributes

• For SAML providers:

  • MetadataFile or MetadataURL

  • IDPSignout optional

withProviderDetails

public CreateIdentityProviderRequest withProviderDetails(Map<String,String> providerDetails)

The IdP details. The following list describes the provider detail keys for each IdP type.

• For Google and Login with Amazon:

  • client_id

  • client_secret

  • authorize_scopes

• For Facebook:

  • client_id

  • client_secret

  • authorize_scopes

  • api_version

• For Sign in with Apple:

  • client_id

  • team_id

  • key_id

  • private_key

  • authorize_scopes

• For OpenID Connect (OIDC) providers:

  • client_id

  • client_secret

  • attributes_request_method

  • oidc_issuer

  • authorize_scopes

  • The following keys are only present if Amazon Cognito didn't discover them at the oidc_issuer URL.

    • authorize_url

    • token_url

    • attributes_url

    • jwks_uri

  • Amazon Cognito sets the value of the following keys automatically. They are read-only.

    • attributes_url_add_attributes

• For SAML providers:

  • MetadataFile or MetadataURL

  • IDPSignout optional

Parameters:

providerDetails - The IdP details. The following list describes the provider detail keys for each IdP type.

• For Google and Login with Amazon:

  • client_id

  • client_secret

  • authorize_scopes

• For Facebook:

  • client_id

  • client_secret

  • authorize_scopes

  • api_version

• For Sign in with Apple:

  • client_id

  • team_id

  • key_id

  • private_key

  • authorize_scopes

• For OpenID Connect (OIDC) providers:

  • client_id

  • client_secret

  • attributes_request_method

  • oidc_issuer

  • authorize_scopes

  • The following keys are only present if Amazon Cognito didn't discover them at the oidc_issuer URL.

    • authorize_url

    • token_url

    • attributes_url

    • jwks_uri

  • Amazon Cognito sets the value of the following keys automatically. They are read-only.

    • attributes_url_add_attributes

• For SAML providers:

  • MetadataFile or MetadataURL

  • IDPSignout optional

Returns:

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

addProviderDetailsEntry

public CreateIdentityProviderRequest addProviderDetailsEntry(String key,
                                                             String value)

Add a single ProviderDetails entry

See Also:

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

clearProviderDetailsEntries

public CreateIdentityProviderRequest clearProviderDetailsEntries()

Removes all the entries added into ProviderDetails.

Returns:

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

getAttributeMapping

public Map<String,String> getAttributeMapping()

A mapping of IdP attributes to standard and custom user pool attributes.

Returns:

A mapping of IdP attributes to standard and custom user pool attributes.

setAttributeMapping

public void setAttributeMapping(Map<String,String> attributeMapping)

A mapping of IdP attributes to standard and custom user pool attributes.

Parameters:

attributeMapping - A mapping of IdP attributes to standard and custom user pool attributes.

withAttributeMapping

public CreateIdentityProviderRequest withAttributeMapping(Map<String,String> attributeMapping)

A mapping of IdP attributes to standard and custom user pool attributes.

Parameters:

attributeMapping - A mapping of IdP attributes to standard and custom user pool attributes.

Returns:

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

addAttributeMappingEntry

public CreateIdentityProviderRequest addAttributeMappingEntry(String key,
                                                              String value)

Add a single AttributeMapping entry

See Also:

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

clearAttributeMappingEntries

public CreateIdentityProviderRequest clearAttributeMappingEntries()

Removes all the entries added into AttributeMapping.

Returns:

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

getIdpIdentifiers

public List<String> getIdpIdentifiers()

A list of IdP identifiers.

Returns:

A list of IdP identifiers.

setIdpIdentifiers

public void setIdpIdentifiers(Collection<String> idpIdentifiers)

A list of IdP identifiers.

Parameters:

idpIdentifiers - A list of IdP identifiers.

withIdpIdentifiers

public CreateIdentityProviderRequest withIdpIdentifiers(String... idpIdentifiers)

A list of IdP identifiers.

NOTE: This method appends the values to the existing list (if any). Use setIdpIdentifiers(java.util.Collection) or withIdpIdentifiers(java.util.Collection) if you want to override the existing values.

Parameters:

idpIdentifiers - A list of IdP identifiers.

Returns:

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

withIdpIdentifiers

public CreateIdentityProviderRequest withIdpIdentifiers(Collection<String> idpIdentifiers)

A list of IdP identifiers.

Parameters:

idpIdentifiers - A list of IdP identifiers.

Returns:

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

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateIdentityProviderRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()