/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.cognitoidp.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** *

* Represents the request to reset a user's password as an administrator. *

* * @see AWS * API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class AdminResetUserPasswordRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *

* The user pool ID for the user pool where you want to reset the user's password. *

*/ private String userPoolId; /** *

* The user name of the user whose password you want to reset. *

*/ private String username; /** *

* A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. *

*

* You create custom workflows by assigning Lambda functions to user pool triggers. When you use the * AdminResetUserPassword API action, Amazon Cognito invokes the function that is assigned to the custom * message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function * receives as input. This payload contains a clientMetadata attribute, which provides the data that * you assigned to the ClientMetadata parameter in your AdminResetUserPassword request. In your function code in * Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs. *

*

* For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. *

* *

* When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following: *

* * */ private java.util.Map clientMetadata; /** *

* The user pool ID for the user pool where you want to reset the user's password. *

* * @param userPoolId * The user pool ID for the user pool where you want to reset the user's password. */ public void setUserPoolId(String userPoolId) { this.userPoolId = userPoolId; } /** *

* The user pool ID for the user pool where you want to reset the user's password. *

* * @return The user pool ID for the user pool where you want to reset the user's password. */ public String getUserPoolId() { return this.userPoolId; } /** *

* The user pool ID for the user pool where you want to reset the user's password. *

* * @param userPoolId * The user pool ID for the user pool where you want to reset the user's password. * @return Returns a reference to this object so that method calls can be chained together. */ public AdminResetUserPasswordRequest withUserPoolId(String userPoolId) { setUserPoolId(userPoolId); return this; } /** *

* The user name of the user whose password you want to reset. *

* * @param username * The user name of the user whose password you want to reset. */ public void setUsername(String username) { this.username = username; } /** *

* The user name of the user whose password you want to reset. *

* * @return The user name of the user whose password you want to reset. */ public String getUsername() { return this.username; } /** *

* The user name of the user whose password you want to reset. *

* * @param username * The user name of the user whose password you want to reset. * @return Returns a reference to this object so that method calls can be chained together. */ public AdminResetUserPasswordRequest withUsername(String username) { setUsername(username); return this; } /** *

* A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. *

*

* You create custom workflows by assigning Lambda functions to user pool triggers. When you use the * AdminResetUserPassword API action, Amazon Cognito invokes the function that is assigned to the custom * message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function * receives as input. This payload contains a clientMetadata attribute, which provides the data that * you assigned to the ClientMetadata parameter in your AdminResetUserPassword request. In your function code in * Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs. *

*

* For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. *

* *

* When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following: *

* * * * @return A map of custom key-value pairs that you can provide as input for any custom workflows that this action * triggers.

*

* You create custom workflows by assigning Lambda functions to user pool triggers. When you use the * AdminResetUserPassword API action, Amazon Cognito invokes the function that is assigned to the custom * message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the * function receives as input. This payload contains a clientMetadata attribute, which provides * the data that you assigned to the ClientMetadata parameter in your AdminResetUserPassword request. In * your function code in Lambda, you can process the clientMetadata value to enhance your * workflow for your specific needs. *

*

* For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. *

* *

* When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following: *

* */ public java.util.Map getClientMetadata() { return clientMetadata; } /** *

* A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. *

*

* You create custom workflows by assigning Lambda functions to user pool triggers. When you use the * AdminResetUserPassword API action, Amazon Cognito invokes the function that is assigned to the custom * message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function * receives as input. This payload contains a clientMetadata attribute, which provides the data that * you assigned to the ClientMetadata parameter in your AdminResetUserPassword request. In your function code in * Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs. *

*

* For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. *

* *

* When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following: *

*
    *
  • *

    * Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool * to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata * parameter serves no purpose. *

    *
    • *
  • *

    * Validate the ClientMetadata value. *

    *
    • *
  • *

    * Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information. *

    *
    • *
* * * @param clientMetadata * A map of custom key-value pairs that you can provide as input for any custom workflows that this action * triggers.

*

* You create custom workflows by assigning Lambda functions to user pool triggers. When you use the * AdminResetUserPassword API action, Amazon Cognito invokes the function that is assigned to the custom * message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the * function receives as input. This payload contains a clientMetadata attribute, which provides * the data that you assigned to the ClientMetadata parameter in your AdminResetUserPassword request. In your * function code in Lambda, you can process the clientMetadata value to enhance your workflow * for your specific needs. *

*

* For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. *

* *

* When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following: *

*
    *
  • *

    * Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user * pool to support custom workflows. If your user pool configuration doesn't include triggers, the * ClientMetadata parameter serves no purpose. *

    *
    • *
  • *

    * Validate the ClientMetadata value. *

    *
    • *
  • *

    * Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information. *

    *
    • *
*/ public void setClientMetadata(java.util.Map clientMetadata) { this.clientMetadata = clientMetadata; } /** *

* A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. *

*

* You create custom workflows by assigning Lambda functions to user pool triggers. When you use the * AdminResetUserPassword API action, Amazon Cognito invokes the function that is assigned to the custom * message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function * receives as input. This payload contains a clientMetadata attribute, which provides the data that * you assigned to the ClientMetadata parameter in your AdminResetUserPassword request. In your function code in * Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs. *

*

* For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. *

* *

* When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following: *

*
    *
  • *

    * Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool * to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata * parameter serves no purpose. *

    *
    • *
  • *

    * Validate the ClientMetadata value. *

    *
    • *
  • *

    * Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information. *

    *
    • *
* * * @param clientMetadata * A map of custom key-value pairs that you can provide as input for any custom workflows that this action * triggers.

*

* You create custom workflows by assigning Lambda functions to user pool triggers. When you use the * AdminResetUserPassword API action, Amazon Cognito invokes the function that is assigned to the custom * message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the * function receives as input. This payload contains a clientMetadata attribute, which provides * the data that you assigned to the ClientMetadata parameter in your AdminResetUserPassword request. In your * function code in Lambda, you can process the clientMetadata value to enhance your workflow * for your specific needs. *

*

* For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. *

* *

* When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following: *

*
    *
  • *

    * Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user * pool to support custom workflows. If your user pool configuration doesn't include triggers, the * ClientMetadata parameter serves no purpose. *

    *
    • *
  • *

    * Validate the ClientMetadata value. *

    *
    • *
  • *

    * Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information. *

    *
    • *
* @return Returns a reference to this object so that method calls can be chained together. */ public AdminResetUserPasswordRequest withClientMetadata(java.util.Map clientMetadata) { setClientMetadata(clientMetadata); return this; } /** * Add a single ClientMetadata entry * * @see AdminResetUserPasswordRequest#withClientMetadata * @returns a reference to this object so that method calls can be chained together. */ public AdminResetUserPasswordRequest addClientMetadataEntry(String key, String value) { if (null == this.clientMetadata) { this.clientMetadata = new java.util.HashMap(); } if (this.clientMetadata.containsKey(key)) throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided."); this.clientMetadata.put(key, value); return this; } /** * Removes all the entries added into ClientMetadata. * * @return Returns a reference to this object so that method calls can be chained together. */ public AdminResetUserPasswordRequest clearClientMetadataEntries() { this.clientMetadata = null; return this; } /** * Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be * redacted from this string using a placeholder value. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getUserPoolId() != null) sb.append("UserPoolId: ").append(getUserPoolId()).append(","); if (getUsername() != null) sb.append("Username: ").append("***Sensitive Data Redacted***").append(","); if (getClientMetadata() != null) sb.append("ClientMetadata: ").append(getClientMetadata()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof AdminResetUserPasswordRequest == false) return false; AdminResetUserPasswordRequest other = (AdminResetUserPasswordRequest) obj; if (other.getUserPoolId() == null ^ this.getUserPoolId() == null) return false; if (other.getUserPoolId() != null && other.getUserPoolId().equals(this.getUserPoolId()) == false) return false; if (other.getUsername() == null ^ this.getUsername() == null) return false; if (other.getUsername() != null && other.getUsername().equals(this.getUsername()) == false) return false; if (other.getClientMetadata() == null ^ this.getClientMetadata() == null) return false; if (other.getClientMetadata() != null && other.getClientMetadata().equals(this.getClientMetadata()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getUserPoolId() == null) ? 0 : getUserPoolId().hashCode()); hashCode = prime * hashCode + ((getUsername() == null) ? 0 : getUsername().hashCode()); hashCode = prime * hashCode + ((getClientMetadata() == null) ? 0 : getClientMetadata().hashCode()); return hashCode; } @Override public AdminResetUserPasswordRequest clone() { return (AdminResetUserPasswordRequest) super.clone(); } }