/* * 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 resend the confirmation code. *

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

* The ID of the client associated with the user pool. *

*/ private String clientId; /** *

* A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and * username plus the client ID in the message. *

*/ private String secretHash; /** *

* Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito * advanced security evaluates the risk of an authentication event based on the context that your app generates and * passes to Amazon Cognito when it makes API requests. *

*/ private UserContextDataType userContextData; /** *

* The username attribute of the user to whom you want to resend a confirmation code. *

*/ private String username; /** *

* The Amazon Pinpoint analytics metadata that contributes to your metrics for ResendConfirmationCode * calls. *

*/ private AnalyticsMetadataType analyticsMetadata; /** *

* 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 * ResendConfirmationCode 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 ResendConfirmationCode 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 ID of the client associated with the user pool. *

* * @param clientId * The ID of the client associated with the user pool. */ public void setClientId(String clientId) { this.clientId = clientId; } /** *

* The ID of the client associated with the user pool. *

* * @return The ID of the client associated with the user pool. */ public String getClientId() { return this.clientId; } /** *

* The ID of the client associated with the user pool. *

* * @param clientId * The ID of the client associated with the user pool. * @return Returns a reference to this object so that method calls can be chained together. */ public ResendConfirmationCodeRequest withClientId(String clientId) { setClientId(clientId); return this; } /** *

* A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and * username plus the client ID in the message. *

* * @param secretHash * A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and * username plus the client ID in the message. */ public void setSecretHash(String secretHash) { this.secretHash = secretHash; } /** *

* A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and * username plus the client ID in the message. *

* * @return A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and * username plus the client ID in the message. */ public String getSecretHash() { return this.secretHash; } /** *

* A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and * username plus the client ID in the message. *

* * @param secretHash * A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and * username plus the client ID in the message. * @return Returns a reference to this object so that method calls can be chained together. */ public ResendConfirmationCodeRequest withSecretHash(String secretHash) { setSecretHash(secretHash); return this; } /** *

* Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito * advanced security evaluates the risk of an authentication event based on the context that your app generates and * passes to Amazon Cognito when it makes API requests. *

* * @param userContextData * Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon * Cognito advanced security evaluates the risk of an authentication event based on the context that your app * generates and passes to Amazon Cognito when it makes API requests. */ public void setUserContextData(UserContextDataType userContextData) { this.userContextData = userContextData; } /** *

* Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito * advanced security evaluates the risk of an authentication event based on the context that your app generates and * passes to Amazon Cognito when it makes API requests. *

* * @return Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon * Cognito advanced security evaluates the risk of an authentication event based on the context that your * app generates and passes to Amazon Cognito when it makes API requests. */ public UserContextDataType getUserContextData() { return this.userContextData; } /** *

* Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito * advanced security evaluates the risk of an authentication event based on the context that your app generates and * passes to Amazon Cognito when it makes API requests. *

* * @param userContextData * Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon * Cognito advanced security evaluates the risk of an authentication event based on the context that your app * generates and passes to Amazon Cognito when it makes API requests. * @return Returns a reference to this object so that method calls can be chained together. */ public ResendConfirmationCodeRequest withUserContextData(UserContextDataType userContextData) { setUserContextData(userContextData); return this; } /** *

* The username attribute of the user to whom you want to resend a confirmation code. *

* * @param username * The username attribute of the user to whom you want to resend a confirmation code. */ public void setUsername(String username) { this.username = username; } /** *

* The username attribute of the user to whom you want to resend a confirmation code. *

* * @return The username attribute of the user to whom you want to resend a confirmation code. */ public String getUsername() { return this.username; } /** *

* The username attribute of the user to whom you want to resend a confirmation code. *

* * @param username * The username attribute of the user to whom you want to resend a confirmation code. * @return Returns a reference to this object so that method calls can be chained together. */ public ResendConfirmationCodeRequest withUsername(String username) { setUsername(username); return this; } /** *

* The Amazon Pinpoint analytics metadata that contributes to your metrics for ResendConfirmationCode * calls. *

* * @param analyticsMetadata * The Amazon Pinpoint analytics metadata that contributes to your metrics for * ResendConfirmationCode calls. */ public void setAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata) { this.analyticsMetadata = analyticsMetadata; } /** *

* The Amazon Pinpoint analytics metadata that contributes to your metrics for ResendConfirmationCode * calls. *

* * @return The Amazon Pinpoint analytics metadata that contributes to your metrics for * ResendConfirmationCode calls. */ public AnalyticsMetadataType getAnalyticsMetadata() { return this.analyticsMetadata; } /** *

* The Amazon Pinpoint analytics metadata that contributes to your metrics for ResendConfirmationCode * calls. *

* * @param analyticsMetadata * The Amazon Pinpoint analytics metadata that contributes to your metrics for * ResendConfirmationCode calls. * @return Returns a reference to this object so that method calls can be chained together. */ public ResendConfirmationCodeRequest withAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata) { setAnalyticsMetadata(analyticsMetadata); 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 * ResendConfirmationCode 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 ResendConfirmationCode 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 * ResendConfirmationCode 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 ResendConfirmationCode 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 * ResendConfirmationCode 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 ResendConfirmationCode 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 * ResendConfirmationCode 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 ResendConfirmationCode 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 * ResendConfirmationCode 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 ResendConfirmationCode 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 * ResendConfirmationCode 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 ResendConfirmationCode 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 ResendConfirmationCodeRequest withClientMetadata(java.util.Map clientMetadata) { setClientMetadata(clientMetadata); return this; } /** * Add a single ClientMetadata entry * * @see ResendConfirmationCodeRequest#withClientMetadata * @returns a reference to this object so that method calls can be chained together. */ public ResendConfirmationCodeRequest 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 ResendConfirmationCodeRequest 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 (getClientId() != null) sb.append("ClientId: ").append("***Sensitive Data Redacted***").append(","); if (getSecretHash() != null) sb.append("SecretHash: ").append("***Sensitive Data Redacted***").append(","); if (getUserContextData() != null) sb.append("UserContextData: ").append("***Sensitive Data Redacted***").append(","); if (getUsername() != null) sb.append("Username: ").append("***Sensitive Data Redacted***").append(","); if (getAnalyticsMetadata() != null) sb.append("AnalyticsMetadata: ").append(getAnalyticsMetadata()).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 ResendConfirmationCodeRequest == false) return false; ResendConfirmationCodeRequest other = (ResendConfirmationCodeRequest) obj; if (other.getClientId() == null ^ this.getClientId() == null) return false; if (other.getClientId() != null && other.getClientId().equals(this.getClientId()) == false) return false; if (other.getSecretHash() == null ^ this.getSecretHash() == null) return false; if (other.getSecretHash() != null && other.getSecretHash().equals(this.getSecretHash()) == false) return false; if (other.getUserContextData() == null ^ this.getUserContextData() == null) return false; if (other.getUserContextData() != null && other.getUserContextData().equals(this.getUserContextData()) == 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.getAnalyticsMetadata() == null ^ this.getAnalyticsMetadata() == null) return false; if (other.getAnalyticsMetadata() != null && other.getAnalyticsMetadata().equals(this.getAnalyticsMetadata()) == 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 + ((getClientId() == null) ? 0 : getClientId().hashCode()); hashCode = prime * hashCode + ((getSecretHash() == null) ? 0 : getSecretHash().hashCode()); hashCode = prime * hashCode + ((getUserContextData() == null) ? 0 : getUserContextData().hashCode()); hashCode = prime * hashCode + ((getUsername() == null) ? 0 : getUsername().hashCode()); hashCode = prime * hashCode + ((getAnalyticsMetadata() == null) ? 0 : getAnalyticsMetadata().hashCode()); hashCode = prime * hashCode + ((getClientMetadata() == null) ? 0 : getClientMetadata().hashCode()); return hashCode; } @Override public ResendConfirmationCodeRequest clone() { return (ResendConfirmationCodeRequest) super.clone(); } }