Package software.amazon.awscdk.services.cognito.identitypool

Class IdentityPool.Builder

java.lang.Object
software.amazon.awscdk.services.cognito.identitypool.IdentityPool.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<IdentityPool>
Enclosing class:
IdentityPool
@Stability(Stable) public static final class IdentityPool.Builder extends Object implements software.amazon.jsii.Builder<IdentityPool>
A fluent builder for IdentityPool.

  • Method Details

    • create

      @Stability(Stable) public static IdentityPool.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of IdentityPool.Builder.

    • allowClassicFlow

      @Stability(Stable) public IdentityPool.Builder allowClassicFlow(Boolean allowClassicFlow)
      Enables the Basic (Classic) authentication flow.

      Default: - Classic Flow not allowed

      Parameters:
      allowClassicFlow - Enables the Basic (Classic) authentication flow. This parameter is required.
      Returns:
      this

    • allowUnauthenticatedIdentities

      @Stability(Stable) public IdentityPool.Builder allowUnauthenticatedIdentities(Boolean allowUnauthenticatedIdentities)
      Whether the Identity Pool supports unauthenticated logins.

      Default: - false

      Parameters:
      allowUnauthenticatedIdentities - Whether the Identity Pool supports unauthenticated logins. This parameter is required.
      Returns:
      this

    • authenticatedRole

      @Stability(Stable) public IdentityPool.Builder authenticatedRole(IRole authenticatedRole)
      The default Role to be assumed by authenticated users.

      Default: - A default authenticated Role will be added

      Parameters:
      authenticatedRole - The default Role to be assumed by authenticated users. This parameter is required.
      Returns:
      this

    • authenticationProviders

      @Stability(Stable) public IdentityPool.Builder authenticationProviders(IdentityPoolAuthenticationProviders authenticationProviders)
      Authentication Providers for using in Identity Pool.

      Default: - No Authentication Providers passed directly to Identity Pool

      Parameters:
      authenticationProviders - Authentication Providers for using in Identity Pool. This parameter is required.
      Returns:
      this

    • identityPoolName

      @Stability(Stable) public IdentityPool.Builder identityPoolName(String identityPoolName)
      The name of the Identity Pool.

      Default: - Automatically generated name by CloudFormation at deploy time

      Parameters:
      identityPoolName - The name of the Identity Pool. This parameter is required.
      Returns:
      this

    • roleMappings

      @Stability(Stable) public IdentityPool.Builder roleMappings(List<? extends IdentityPoolRoleMapping> roleMappings)
      Rules for mapping roles to users.

      Default: - no role mappings

      Parameters:
      roleMappings - Rules for mapping roles to users. This parameter is required.
      Returns:
      this

    • unauthenticatedRole

      @Stability(Stable) public IdentityPool.Builder unauthenticatedRole(IRole unauthenticatedRole)
      The default Role to be assumed by unauthenticated users.

      Default: - A default unauthenticated Role will be added

      Parameters:
      unauthenticatedRole - The default Role to be assumed by unauthenticated users. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public IdentityPool build()
      Specified by:
      build in interface software.amazon.jsii.Builder<IdentityPool>
      Returns:
      a newly built instance of IdentityPool.