Package software.amazon.awssdk.services.cognitoidentityprovider.model

Interface CreateIdentityProviderRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CognitoIdentityProviderRequest.Builder, CopyableBuilder<CreateIdentityProviderRequest.Builder,CreateIdentityProviderRequest>, SdkBuilder<CreateIdentityProviderRequest.Builder,CreateIdentityProviderRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateIdentityProviderRequest

public static interface CreateIdentityProviderRequest.Builder
extends CognitoIdentityProviderRequest.Builder, SdkPojo, CopyableBuilder<CreateIdentityProviderRequest.Builder,CreateIdentityProviderRequest>

Method Summary

Modifier and Type	Method	Description
CreateIdentityProviderRequest.Builder	attributeMapping(Map<String,String> attributeMapping)	A mapping of IdP attributes to standard and custom user pool attributes.
CreateIdentityProviderRequest.Builder	idpIdentifiers(String... idpIdentifiers)	A list of IdP identifiers.
CreateIdentityProviderRequest.Builder	idpIdentifiers(Collection<String> idpIdentifiers)	A list of IdP identifiers.
CreateIdentityProviderRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateIdentityProviderRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateIdentityProviderRequest.Builder	providerDetails(Map<String,String> providerDetails)	The IdP details.
CreateIdentityProviderRequest.Builder	providerName(String providerName)	The IdP name.
CreateIdentityProviderRequest.Builder	providerType(String providerType)	The IdP type.
CreateIdentityProviderRequest.Builder	providerType(IdentityProviderTypeType providerType)	The IdP type.
CreateIdentityProviderRequest.Builder	userPoolId(String userPoolId)	The user pool ID.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Detail

userPoolId

CreateIdentityProviderRequest.Builder userPoolId(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.

providerName

CreateIdentityProviderRequest.Builder providerName(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.

providerType

CreateIdentityProviderRequest.Builder providerType(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, IdentityProviderTypeType

providerType

CreateIdentityProviderRequest.Builder providerType(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, IdentityProviderTypeType

providerDetails

CreateIdentityProviderRequest.Builder providerDetails(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.

attributeMapping

CreateIdentityProviderRequest.Builder attributeMapping(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.

idpIdentifiers

CreateIdentityProviderRequest.Builder idpIdentifiers(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.

idpIdentifiers

CreateIdentityProviderRequest.Builder idpIdentifiers(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.

overrideConfiguration

CreateIdentityProviderRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateIdentityProviderRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder