software.amazon.awssdk.services.cognitoidentityprovider.model

Interface IdentityProviderType.Builder

All Superinterfaces:

Buildable, CopyableBuilder<IdentityProviderType.Builder,IdentityProviderType>, SdkBuilder<IdentityProviderType.Builder,IdentityProviderType>, SdkPojo

Enclosing class:

IdentityProviderType

public static interface IdentityProviderType.Builder
extends SdkPojo, CopyableBuilder<IdentityProviderType.Builder,IdentityProviderType>

Method Summary

Modifier and Type	Method and Description
IdentityProviderType.Builder	attributeMapping(Map<String,String> attributeMapping) A mapping of identity provider attributes to standard and custom user pool attributes.
IdentityProviderType.Builder	creationDate(Instant creationDate) The date the identity provider was created.
IdentityProviderType.Builder	idpIdentifiers(Collection<String> idpIdentifiers) A list of identity provider identifiers.
IdentityProviderType.Builder	idpIdentifiers(String... idpIdentifiers) A list of identity provider identifiers.
IdentityProviderType.Builder	lastModifiedDate(Instant lastModifiedDate) The date the identity provider was last modified.
IdentityProviderType.Builder	providerDetails(Map<String,String> providerDetails) The identity provider details.
IdentityProviderType.Builder	providerName(String providerName) The identity provider name.
IdentityProviderType.Builder	providerType(IdentityProviderTypeType providerType) The identity provider type.
IdentityProviderType.Builder	providerType(String providerType) The identity provider type.
IdentityProviderType.Builder	userPoolId(String userPoolId) The user pool ID.

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

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

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

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

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

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

  • authorize_scopes

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

  • authorize_scopes

• For SAML providers:

  • MetadataFile OR MetadataURL

  • IDPSignOut optional

Returns:

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

attributeMapping

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

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

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

lastModifiedDate

IdentityProviderType.Builder lastModifiedDate(Instant lastModifiedDate)

The date the identity provider was last modified.

Parameters:

lastModifiedDate - The date the identity provider was last modified.

Returns:

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

creationDate

IdentityProviderType.Builder creationDate(Instant creationDate)

The date the identity provider was created.

Parameters:

creationDate - The date the identity provider was created.

Returns:

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