Interface CognitoUserPoolConfiguration.Builder

All Superinterfaces:
Buildable, CopyableBuilder<CognitoUserPoolConfiguration.Builder,CognitoUserPoolConfiguration>, SdkBuilder<CognitoUserPoolConfiguration.Builder,CognitoUserPoolConfiguration>, SdkPojo
Enclosing class:
CognitoUserPoolConfiguration

public static interface CognitoUserPoolConfiguration.Builder extends SdkPojo, CopyableBuilder<CognitoUserPoolConfiguration.Builder,CognitoUserPoolConfiguration>
  • Method Details

    • userPoolArn

      CognitoUserPoolConfiguration.Builder userPoolArn(String userPoolArn)

      The Amazon Resource Name (ARN) of the Amazon Cognito user pool that contains the identities to be authorized.

      Example: "UserPoolArn": "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5"

      Parameters:
      userPoolArn - The Amazon Resource Name (ARN) of the Amazon Cognito user pool that contains the identities to be authorized.

      Example: "UserPoolArn": "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5"

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

      The unique application client IDs that are associated with the specified Amazon Cognito user pool.

      Example: "ClientIds": ["&ExampleCogClientId;"]

      Parameters:
      clientIds - The unique application client IDs that are associated with the specified Amazon Cognito user pool.

      Example: "ClientIds": ["&ExampleCogClientId;"]

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

      The unique application client IDs that are associated with the specified Amazon Cognito user pool.

      Example: "ClientIds": ["&ExampleCogClientId;"]

      Parameters:
      clientIds - The unique application client IDs that are associated with the specified Amazon Cognito user pool.

      Example: "ClientIds": ["&ExampleCogClientId;"]

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

      CognitoUserPoolConfiguration.Builder groupConfiguration(CognitoGroupConfiguration groupConfiguration)

      The configuration of the user groups from an Amazon Cognito user pool identity source.

      Parameters:
      groupConfiguration - The configuration of the user groups from an Amazon Cognito user pool identity source.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • groupConfiguration

      default CognitoUserPoolConfiguration.Builder groupConfiguration(Consumer<CognitoGroupConfiguration.Builder> groupConfiguration)

      The configuration of the user groups from an Amazon Cognito user pool identity source.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to groupConfiguration(CognitoGroupConfiguration).

      Parameters:
      groupConfiguration - a consumer that will call methods on CognitoGroupConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: