com.amazonaws.services.cognitoidentityprovider.model

Class CreateIdentityProviderRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentityprovider.model.CreateIdentityProviderRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

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

Creates an IdP 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
CreateIdentityProviderRequest()

Method Summary

Modifier and Type	Method and Description
CreateIdentityProviderRequest	addAttributeMappingEntry(java.lang.String key, java.lang.String value) A mapping of IdP attributes to standard and custom user pool attributes.
CreateIdentityProviderRequest	addProviderDetailsEntry(java.lang.String key, java.lang.String value) The IdP details.
CreateIdentityProviderRequest	clearAttributeMappingEntries() Removes all the entries added into AttributeMapping.
CreateIdentityProviderRequest	clearProviderDetailsEntries() Removes all the entries added into ProviderDetails.
boolean	equals(java.lang.Object obj)
java.util.Map<java.lang.String,java.lang.String>	getAttributeMapping() A mapping of IdP attributes to standard and custom user pool attributes.
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.
java.lang.String	getProviderName() The IdP name.
java.lang.String	getProviderType() The IdP type.
java.lang.String	getUserPoolId() The user pool ID.
int	hashCode()
void	setAttributeMapping(java.util.Map<java.lang.String,java.lang.String> attributeMapping) A mapping of IdP attributes to standard and custom user pool attributes.
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.
void	setProviderName(java.lang.String providerName) The IdP name.
void	setProviderType(IdentityProviderTypeType providerType) The IdP type.
void	setProviderType(java.lang.String providerType) The IdP type.
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.
CreateIdentityProviderRequest	withAttributeMapping(java.util.Map<java.lang.String,java.lang.String> attributeMapping) A mapping of IdP attributes to standard and custom user pool attributes.
CreateIdentityProviderRequest	withIdpIdentifiers(java.util.Collection<java.lang.String> idpIdentifiers) A list of IdP identifiers.
CreateIdentityProviderRequest	withIdpIdentifiers(java.lang.String... idpIdentifiers) A list of IdP identifiers.
CreateIdentityProviderRequest	withProviderDetails(java.util.Map<java.lang.String,java.lang.String> providerDetails) The IdP details.
CreateIdentityProviderRequest	withProviderName(java.lang.String providerName) The IdP name.
CreateIdentityProviderRequest	withProviderType(IdentityProviderTypeType providerType) The IdP type.
CreateIdentityProviderRequest	withProviderType(java.lang.String providerType) The IdP type.
CreateIdentityProviderRequest	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

CreateIdentityProviderRequest

public CreateIdentityProviderRequest()

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 CreateIdentityProviderRequest 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: 3 - 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: 3 - 32
Pattern: [^_][\p{L}\p{M}\p{S}\p{N}\p{P}][^_]+

Parameters:

providerName -

The IdP name.

withProviderName

public CreateIdentityProviderRequest withProviderName(java.lang.String providerName)

The IdP name.

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

Constraints:
Length: 3 - 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.

getProviderType

public java.lang.String getProviderType()

The IdP type.

Constraints:
Allowed Values: SAML, Facebook, Google, LoginWithAmazon, SignInWithApple, OIDC

Returns:

The IdP type.

See Also:

IdentityProviderTypeType

setProviderType

public void setProviderType(java.lang.String providerType)

The IdP type.

Constraints:
Allowed Values: SAML, Facebook, Google, LoginWithAmazon, SignInWithApple, OIDC

Parameters:

providerType -

The IdP type.

See Also:

IdentityProviderTypeType

withProviderType

public CreateIdentityProviderRequest withProviderType(java.lang.String providerType)

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

Constraints:
Allowed Values: SAML, Facebook, Google, LoginWithAmazon, SignInWithApple, OIDC

Parameters:

providerType -

The IdP type.

See Also:

IdentityProviderTypeType

withProviderType

public CreateIdentityProviderRequest withProviderType(IdentityProviderTypeType providerType)

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

Returns:

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

See Also:

IdentityProviderTypeType

getProviderDetails

public java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.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

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

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:

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

addProviderDetailsEntry

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

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

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 java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.String> attributeMapping)

A mapping of IdP 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 IdP 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(java.lang.String key,
                                                              java.lang.String value)

A mapping of IdP 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 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 CreateIdentityProviderRequest 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 CreateIdentityProviderRequest 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