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 IdP attributes to standard and custom user pool attributes.
IdentityProviderType.Builder	creationDate(Instant creationDate) The date the IdP was created.
IdentityProviderType.Builder	idpIdentifiers(Collection<String> idpIdentifiers) A list of IdP identifiers.
IdentityProviderType.Builder	idpIdentifiers(String... idpIdentifiers) A list of IdP identifiers.
IdentityProviderType.Builder	lastModifiedDate(Instant lastModifiedDate) The date the IdP was last modified.
IdentityProviderType.Builder	providerDetails(Map<String,String> providerDetails) The IdP details.
IdentityProviderType.Builder	providerName(String providerName) The IdP name.
IdentityProviderType.Builder	providerType(IdentityProviderTypeType providerType) The IdP type.
IdentityProviderType.Builder	providerType(String providerType) The IdP 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 IdP name.

Parameters:

providerName - The IdP name.

Returns:

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

providerType

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

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

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

    You can submit a private_key when you add or update an IdP. Describe operations don't return the private key.

  • authorize_scopes

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

    You can submit a private_key when you add or update an IdP. Describe operations don't return the private key.

  • authorize_scopes

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

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

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

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

lastModifiedDate

IdentityProviderType.Builder lastModifiedDate(Instant lastModifiedDate)

The date the IdP was last modified.

Parameters:

lastModifiedDate - The date the IdP 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 IdP was created.

Parameters:

creationDate - The date the IdP was created.

Returns:

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