Package software.amazon.awssdk.services.cognitoidentityprovider.model

Interface UserPoolDescriptionType.Builder

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

  • Method Details

    • id

      UserPoolDescriptionType.Builder id(String id)

      The user pool ID.

      Parameters:
      id - The user pool ID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      UserPoolDescriptionType.Builder name(String name)

      The user pool name.

      Parameters:
      name - The user pool name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lambdaConfig

      UserPoolDescriptionType.Builder lambdaConfig(LambdaConfigType lambdaConfig)

      A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible stages of user pool operations. Triggers can modify the outcome of the operations that invoked them.

      Parameters:
      lambdaConfig - A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible stages of user pool operations. Triggers can modify the outcome of the operations that invoked them.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lambdaConfig

      default UserPoolDescriptionType.Builder lambdaConfig(Consumer<LambdaConfigType.Builder> lambdaConfig)

      A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible stages of user pool operations. Triggers can modify the outcome of the operations that invoked them.

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

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

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

    • status

      @Deprecated UserPoolDescriptionType.Builder status(String status)
      Deprecated.
      This property is no longer available.

      The user pool status.

      Parameters:
      status - The user pool status.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      @Deprecated UserPoolDescriptionType.Builder status(StatusType status)
      Deprecated.
      This property is no longer available.

      The user pool status.

      Parameters:
      status - The user pool status.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • lastModifiedDate

      UserPoolDescriptionType.Builder lastModifiedDate(Instant lastModifiedDate)

      The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

      Parameters:
      lastModifiedDate - The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • creationDate

      UserPoolDescriptionType.Builder creationDate(Instant creationDate)

      The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

      Parameters:
      creationDate - The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • replicaRegions

      UserPoolDescriptionType.Builder replicaRegions(Collection<String> replicaRegions)

      A list of Amazon Web Services Regions where replicas of this user pool exist.

      Parameters:
      replicaRegions - A list of Amazon Web Services Regions where replicas of this user pool exist.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • replicaRegions

      UserPoolDescriptionType.Builder replicaRegions(String... replicaRegions)

      A list of Amazon Web Services Regions where replicas of this user pool exist.

      Parameters:
      replicaRegions - A list of Amazon Web Services Regions where replicas of this user pool exist.
      Returns:
      Returns a reference to this object so that method calls can be chained together.