Package software.amazon.awssdk.services.cognitoidentity.model

Interface DescribeIdentityPoolResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CognitoIdentityResponse.Builder, CopyableBuilder<DescribeIdentityPoolResponse.Builder,DescribeIdentityPoolResponse>, SdkBuilder<DescribeIdentityPoolResponse.Builder,DescribeIdentityPoolResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

DescribeIdentityPoolResponse

public static interface DescribeIdentityPoolResponse.Builder
extends CognitoIdentityResponse.Builder, SdkPojo, CopyableBuilder<DescribeIdentityPoolResponse.Builder,DescribeIdentityPoolResponse>

Method Summary

Modifier and Type	Method	Description
DescribeIdentityPoolResponse.Builder	allowClassicFlow(Boolean allowClassicFlow)	Enables or disables the Basic (Classic) authentication flow.
DescribeIdentityPoolResponse.Builder	allowUnauthenticatedIdentities(Boolean allowUnauthenticatedIdentities)	TRUE if the identity pool supports unauthenticated logins.
DescribeIdentityPoolResponse.Builder	cognitoIdentityProviders(Collection<CognitoIdentityProvider> cognitoIdentityProviders)	A list representing an Amazon Cognito user pool and its client ID.
DescribeIdentityPoolResponse.Builder	cognitoIdentityProviders(Consumer<CognitoIdentityProvider.Builder>... cognitoIdentityProviders)	A list representing an Amazon Cognito user pool and its client ID.
DescribeIdentityPoolResponse.Builder	cognitoIdentityProviders(CognitoIdentityProvider... cognitoIdentityProviders)	A list representing an Amazon Cognito user pool and its client ID.
DescribeIdentityPoolResponse.Builder	developerProviderName(String developerProviderName)	The "domain" by which Cognito will refer to your users.
DescribeIdentityPoolResponse.Builder	identityPoolId(String identityPoolId)	An identity pool ID in the format REGION:GUID.
DescribeIdentityPoolResponse.Builder	identityPoolName(String identityPoolName)	A string that you provide.
DescribeIdentityPoolResponse.Builder	identityPoolTags(Map<String,String> identityPoolTags)	The tags that are assigned to the identity pool.
DescribeIdentityPoolResponse.Builder	openIdConnectProviderARNs(String... openIdConnectProviderARNs)	The ARNs of the OpenID Connect providers.
DescribeIdentityPoolResponse.Builder	openIdConnectProviderARNs(Collection<String> openIdConnectProviderARNs)	The ARNs of the OpenID Connect providers.
DescribeIdentityPoolResponse.Builder	samlProviderARNs(String... samlProviderARNs)	An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
DescribeIdentityPoolResponse.Builder	samlProviderARNs(Collection<String> samlProviderARNs)	An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
DescribeIdentityPoolResponse.Builder	supportedLoginProviders(Map<String,String> supportedLoginProviders)	Optional key:value pairs mapping provider names to provider app IDs.

Methods inherited from interface software.amazon.awssdk.services.cognitoidentity.model.CognitoIdentityResponse.Builder

build, responseMetadata, responseMetadata

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, sdkFieldNameToField, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Detail

identityPoolId

DescribeIdentityPoolResponse.Builder identityPoolId(String identityPoolId)

An identity pool ID in the format REGION:GUID.

Parameters:

identityPoolId - An identity pool ID in the format REGION:GUID.

Returns:

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

identityPoolName

DescribeIdentityPoolResponse.Builder identityPoolName(String identityPoolName)

A string that you provide.

Parameters:

identityPoolName - A string that you provide.

Returns:

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

allowUnauthenticatedIdentities

DescribeIdentityPoolResponse.Builder allowUnauthenticatedIdentities(Boolean allowUnauthenticatedIdentities)

TRUE if the identity pool supports unauthenticated logins.

Parameters:

allowUnauthenticatedIdentities - TRUE if the identity pool supports unauthenticated logins.

Returns:

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

allowClassicFlow

DescribeIdentityPoolResponse.Builder allowClassicFlow(Boolean allowClassicFlow)

Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide.

Parameters:

allowClassicFlow - Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide.

Returns:

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

supportedLoginProviders

DescribeIdentityPoolResponse.Builder supportedLoginProviders(Map<String,String> supportedLoginProviders)

Optional key:value pairs mapping provider names to provider app IDs.

Parameters:

supportedLoginProviders - Optional key:value pairs mapping provider names to provider app IDs.

Returns:

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

developerProviderName

DescribeIdentityPoolResponse.Builder developerProviderName(String developerProviderName)

The "domain" by which Cognito will refer to your users.

Parameters:

developerProviderName - The "domain" by which Cognito will refer to your users.

Returns:

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

openIdConnectProviderARNs

DescribeIdentityPoolResponse.Builder openIdConnectProviderARNs(Collection<String> openIdConnectProviderARNs)

The ARNs of the OpenID Connect providers.

Parameters:

openIdConnectProviderARNs - The ARNs of the OpenID Connect providers.

Returns:

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

openIdConnectProviderARNs

DescribeIdentityPoolResponse.Builder openIdConnectProviderARNs(String... openIdConnectProviderARNs)

The ARNs of the OpenID Connect providers.

Parameters:

openIdConnectProviderARNs - The ARNs of the OpenID Connect providers.

Returns:

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

cognitoIdentityProviders

DescribeIdentityPoolResponse.Builder cognitoIdentityProviders(Collection<CognitoIdentityProvider> cognitoIdentityProviders)

A list representing an Amazon Cognito user pool and its client ID.

Parameters:

cognitoIdentityProviders - A list representing an Amazon Cognito user pool and its client ID.

Returns:

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

cognitoIdentityProviders

DescribeIdentityPoolResponse.Builder cognitoIdentityProviders(CognitoIdentityProvider... cognitoIdentityProviders)

A list representing an Amazon Cognito user pool and its client ID.

Parameters:

cognitoIdentityProviders - A list representing an Amazon Cognito user pool and its client ID.

Returns:

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

cognitoIdentityProviders

DescribeIdentityPoolResponse.Builder cognitoIdentityProviders(Consumer<CognitoIdentityProvider.Builder>... cognitoIdentityProviders)

A list representing an Amazon Cognito user pool and its client ID.

This is a convenience method that creates an instance of the CognitoIdentityProvider.Builder avoiding the need to create one manually via CognitoIdentityProvider.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #cognitoIdentityProviders(List).

Parameters:

cognitoIdentityProviders - a consumer that will call methods on CognitoIdentityProvider.Builder

Returns:

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

See Also:

#cognitoIdentityProviders(java.util.Collection)

samlProviderARNs

DescribeIdentityPoolResponse.Builder samlProviderARNs(Collection<String> samlProviderARNs)

An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.

Parameters:

samlProviderARNs - An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.

Returns:

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

samlProviderARNs

DescribeIdentityPoolResponse.Builder samlProviderARNs(String... samlProviderARNs)

An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.

Parameters:

samlProviderARNs - An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.

Returns:

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

identityPoolTags

DescribeIdentityPoolResponse.Builder identityPoolTags(Map<String,String> identityPoolTags)

The tags that are assigned to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.

Parameters:

identityPoolTags - The tags that are assigned to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.

Returns:

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