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

Interface AuthEventType.Builder

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

  • Method Details

    • eventId

      AuthEventType.Builder eventId(String eventId)

      The event ID.

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

    • eventType

      AuthEventType.Builder eventType(String eventType)

      The type of authentication event.

      Parameters:
      eventType - The type of authentication event.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • eventType

      AuthEventType.Builder eventType(EventType eventType)

      The type of authentication event.

      Parameters:
      eventType - The type of authentication event.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • creationDate

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

    • eventResponse

      AuthEventType.Builder eventResponse(String eventResponse)

      The event response.

      Parameters:
      eventResponse - The event response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • eventResponse

      AuthEventType.Builder eventResponse(EventResponseType eventResponse)

      The event response.

      Parameters:
      eventResponse - The event response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • eventRisk

      AuthEventType.Builder eventRisk(EventRiskType eventRisk)

      The threat evaluation from your user pool about an event. Contains information about whether your user pool detected compromised credentials, whether the event triggered an automated response, and the level of risk.

      Parameters:
      eventRisk - The threat evaluation from your user pool about an event. Contains information about whether your user pool detected compromised credentials, whether the event triggered an automated response, and the level of risk.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • eventRisk

      default AuthEventType.Builder eventRisk(Consumer<EventRiskType.Builder> eventRisk)

      The threat evaluation from your user pool about an event. Contains information about whether your user pool detected compromised credentials, whether the event triggered an automated response, and the level of risk.

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

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

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

    • challengeResponses

      AuthEventType.Builder challengeResponses(Collection<ChallengeResponseType> challengeResponses)

      A list of the challenges that the user was requested to answer, for example Password, and the result, for example Success.

      Parameters:
      challengeResponses - A list of the challenges that the user was requested to answer, for example Password, and the result, for example Success.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • challengeResponses

      AuthEventType.Builder challengeResponses(ChallengeResponseType... challengeResponses)

      A list of the challenges that the user was requested to answer, for example Password, and the result, for example Success.

      Parameters:
      challengeResponses - A list of the challenges that the user was requested to answer, for example Password, and the result, for example Success.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • challengeResponses

      AuthEventType.Builder challengeResponses(Consumer<ChallengeResponseType.Builder>... challengeResponses)

      A list of the challenges that the user was requested to answer, for example Password, and the result, for example Success.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to challengeResponses(List<ChallengeResponseType>).

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

    • eventContextData

      AuthEventType.Builder eventContextData(EventContextDataType eventContextData)

      The user context data captured at the time of an event request. This value provides additional information about the client from which event the request is received.

      Parameters:
      eventContextData - The user context data captured at the time of an event request. This value provides additional information about the client from which event the request is received.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • eventContextData

      default AuthEventType.Builder eventContextData(Consumer<EventContextDataType.Builder> eventContextData)

      The user context data captured at the time of an event request. This value provides additional information about the client from which event the request is received.

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

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

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

    • eventFeedback

      AuthEventType.Builder eventFeedback(EventFeedbackType eventFeedback)

      The UpdateAuthEventFeedback or AdminUpdateAuthEventFeedback feedback that you or your user provided in response to the event. A value of Valid indicates that you disagreed with the level of risk that your user pool assigned, and evaluated a session to be valid, or likely safe. A value of Invalid indicates that you agreed with the user pool risk level and evaluated a session to be invalid, or likely malicious.

      Parameters:
      eventFeedback - The UpdateAuthEventFeedback or AdminUpdateAuthEventFeedback feedback that you or your user provided in response to the event. A value of Valid indicates that you disagreed with the level of risk that your user pool assigned, and evaluated a session to be valid, or likely safe. A value of Invalid indicates that you agreed with the user pool risk level and evaluated a session to be invalid, or likely malicious.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • eventFeedback

      default AuthEventType.Builder eventFeedback(Consumer<EventFeedbackType.Builder> eventFeedback)

      The UpdateAuthEventFeedback or AdminUpdateAuthEventFeedback feedback that you or your user provided in response to the event. A value of Valid indicates that you disagreed with the level of risk that your user pool assigned, and evaluated a session to be valid, or likely safe. A value of Invalid indicates that you agreed with the user pool risk level and evaluated a session to be invalid, or likely malicious.

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

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

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