Interface AdminRevokeUserSessionRequest.Builder

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

  • Method Details

    • userPoolId

      AdminRevokeUserSessionRequest.Builder userPoolId(String userPoolId)

      The ID of the user pool that contains the session.

      Parameters:
      userPoolId - The ID of the user pool that contains the session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • username

      AdminRevokeUserSessionRequest.Builder username(String username)

      The username of the user who owns the session. The username must match the user associated with the SessionId, to confirm they are the intended target user.

      Parameters:
      username - The username of the user who owns the session. The username must match the user associated with the SessionId, to confirm they are the intended target user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sessionId

      AdminRevokeUserSessionRequest.Builder sessionId(String sessionId)

      The ID of the session to revoke. This is a 28-character string of lowercase letters and digits, prefixed with tkn for a token session or sso for an SSO session.

      Parameters:
      sessionId - The ID of the session to revoke. This is a 28-character string of lowercase letters and digits, prefixed with tkn for a token session or sso for an SSO session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • revokeAssociatedSessions

      AdminRevokeUserSessionRequest.Builder revokeAssociatedSessions(String revokeAssociatedSessions)

      Specifies whether to also revoke the sessions that are linked to the targeted session. NONE, the default, revokes only the targeted session. LINKED also revokes the directly linked session or sessions, interpreted relative to the type of the targeted session: revoking a token session also revokes the parent SSO session it came through, and revoking an SSO session also revokes the token sessions that came through it. The set of linked sessions is eventually consistent, so associated sessions are typically revoked within a few seconds.

      Parameters:
      revokeAssociatedSessions - Specifies whether to also revoke the sessions that are linked to the targeted session. NONE, the default, revokes only the targeted session. LINKED also revokes the directly linked session or sessions, interpreted relative to the type of the targeted session: revoking a token session also revokes the parent SSO session it came through, and revoking an SSO session also revokes the token sessions that came through it. The set of linked sessions is eventually consistent, so associated sessions are typically revoked within a few seconds.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • revokeAssociatedSessions

      AdminRevokeUserSessionRequest.Builder revokeAssociatedSessions(RevokeAssociatedSessionsType revokeAssociatedSessions)

      Specifies whether to also revoke the sessions that are linked to the targeted session. NONE, the default, revokes only the targeted session. LINKED also revokes the directly linked session or sessions, interpreted relative to the type of the targeted session: revoking a token session also revokes the parent SSO session it came through, and revoking an SSO session also revokes the token sessions that came through it. The set of linked sessions is eventually consistent, so associated sessions are typically revoked within a few seconds.

      Parameters:
      revokeAssociatedSessions - Specifies whether to also revoke the sessions that are linked to the targeted session. NONE, the default, revokes only the targeted session. LINKED also revokes the directly linked session or sessions, interpreted relative to the type of the targeted session: revoking a token session also revokes the parent SSO session it came through, and revoking an SSO session also revokes the token sessions that came through it. The set of linked sessions is eventually consistent, so associated sessions are typically revoked within a few seconds.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

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

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