Interface UpdateIdentityPoolRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CognitoIdentityRequest.Builder, CopyableBuilder<UpdateIdentityPoolRequest.Builder,UpdateIdentityPoolRequest>, SdkBuilder<UpdateIdentityPoolRequest.Builder,UpdateIdentityPoolRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
UpdateIdentityPoolRequest
@Mutable @NotThreadSafe public static interface UpdateIdentityPoolRequest.Builder extends CognitoIdentityRequest.Builder, SdkPojo, CopyableBuilder<UpdateIdentityPoolRequest.Builder,UpdateIdentityPoolRequest>

  • Method Details

    • identityPoolId

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

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

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

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

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

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

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

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

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

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

      UpdateIdentityPoolRequest.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<CognitoIdentityProvider>).

      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:

    • samlProviderARNs

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

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

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

    • overrideConfiguration

      UpdateIdentityPoolRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      UpdateIdentityPoolRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.