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 and Description
CreateIdentityProviderRequest.Builder	attributeMapping(Map<String,String> attributeMapping) A mapping of identity provider attributes to standard and custom user pool attributes.
CreateIdentityProviderRequest.Builder	idpIdentifiers(Collection<String> idpIdentifiers) A list of identity provider identifiers.
CreateIdentityProviderRequest.Builder	idpIdentifiers(String... idpIdentifiers) A list of identity provider identifiers.
CreateIdentityProviderRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateIdentityProviderRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateIdentityProviderRequest.Builder	providerDetails(Map<String,String> providerDetails) The identity provider details.
CreateIdentityProviderRequest.Builder	providerName(String providerName) The identity provider name.
CreateIdentityProviderRequest.Builder	providerType(IdentityProviderTypeType providerType) The identity provider type.
CreateIdentityProviderRequest.Builder	providerType(String providerType) The identity provider type.
CreateIdentityProviderRequest.Builder	userPoolId(String userPoolId) The user pool ID.

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

build

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

overrideConfiguration

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

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 identity provider name.

Parameters:

providerName - The identity provider name.

Returns:

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

providerType

CreateIdentityProviderRequest.Builder providerType(String providerType)

The identity provider type.

Parameters:

providerType - The identity provider 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 identity provider type.

Parameters:

providerType - The identity provider 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 identity provider details. The following list describes the provider detail keys for each identity provider 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

  • authorize_url if not available from discovery URL specified by oidc_issuer key

  • token_url if not available from discovery URL specified by oidc_issuer key

  • attributes_url if not available from discovery URL specified by oidc_issuer key

  • jwks_uri if not available from discovery URL specified by oidc_issuer key

  • attributes_url_add_attributes a read-only property that is set automatically

• For SAML providers:

  • MetadataFile OR MetadataURL

  • IDPSignout (optional)

Parameters:

providerDetails - The identity provider details. The following list describes the provider detail keys for each identity provider 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

  • authorize_url if not available from discovery URL specified by oidc_issuer key

  • token_url if not available from discovery URL specified by oidc_issuer key

  • attributes_url if not available from discovery URL specified by oidc_issuer key

  • jwks_uri if not available from discovery URL specified by oidc_issuer key

  • attributes_url_add_attributes a read-only property that is set automatically

• 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 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.

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 identity provider identifiers.

Parameters:

idpIdentifiers - A list of identity provider 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 identity provider identifiers.

Parameters:

idpIdentifiers - A list of identity provider 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