VerificationMessageTemplateType (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.cognitoidp.model.VerificationMessageTemplateType

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class VerificationMessageTemplateType
extends Object
implements Serializable, Cloneable, StructuredPojo

The template for verification messages.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

VerificationMessageTemplateType()

Constructors
Constructor and Description
`VerificationMessageTemplateType()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`VerificationMessageTemplateType`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDefaultEmailOption()` The default email option.
`String`	`getEmailMessage()` The template for email messages that Amazon Cognito sends to your users.
`String`	`getEmailMessageByLink()` The email message template for sending a confirmation link to the user.
`String`	`getEmailSubject()` The subject line for the email message template.
`String`	`getEmailSubjectByLink()` The subject line for the email message template for sending a confirmation link to the user.
`String`	`getSmsMessage()` The template for SMS messages that Amazon Cognito sends to your users.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDefaultEmailOption(String defaultEmailOption)` The default email option.
`void`	`setEmailMessage(String emailMessage)` The template for email messages that Amazon Cognito sends to your users.
`void`	`setEmailMessageByLink(String emailMessageByLink)` The email message template for sending a confirmation link to the user.
`void`	`setEmailSubject(String emailSubject)` The subject line for the email message template.
`void`	`setEmailSubjectByLink(String emailSubjectByLink)` The subject line for the email message template for sending a confirmation link to the user.
`void`	`setSmsMessage(String smsMessage)` The template for SMS messages that Amazon Cognito sends to your users.
`String`	`toString()` Returns a string representation of this object.
`VerificationMessageTemplateType`	`withDefaultEmailOption(DefaultEmailOptionType defaultEmailOption)` The default email option.
`VerificationMessageTemplateType`	`withDefaultEmailOption(String defaultEmailOption)` The default email option.
`VerificationMessageTemplateType`	`withEmailMessage(String emailMessage)` The template for email messages that Amazon Cognito sends to your users.
`VerificationMessageTemplateType`	`withEmailMessageByLink(String emailMessageByLink)` The email message template for sending a confirmation link to the user.
`VerificationMessageTemplateType`	`withEmailSubject(String emailSubject)` The subject line for the email message template.
`VerificationMessageTemplateType`	`withEmailSubjectByLink(String emailSubjectByLink)` The subject line for the email message template for sending a confirmation link to the user.
`VerificationMessageTemplateType`	`withSmsMessage(String smsMessage)` The template for SMS messages that Amazon Cognito sends to your users.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - VerificationMessageTemplateType
```
public VerificationMessageTemplateType()
```
- Method Detail
  - setSmsMessage
```
public void setSmsMessage(String smsMessage)
```
    The template for SMS messages that Amazon Cognito sends to your users.
    
    Parameters:
    
    smsMessage - The template for SMS messages that Amazon Cognito sends to your users.
  - getSmsMessage
```
public String getSmsMessage()
```
    The template for SMS messages that Amazon Cognito sends to your users.
    
    Returns:
    
    The template for SMS messages that Amazon Cognito sends to your users.
  - withSmsMessage
```
public VerificationMessageTemplateType withSmsMessage(String smsMessage)
```
    The template for SMS messages that Amazon Cognito sends to your users.
    
    Parameters:
    
    smsMessage - The template for SMS messages that Amazon Cognito sends to your users.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEmailMessage
```
public void setEmailMessage(String emailMessage)
```
    The template for email messages that Amazon Cognito sends to your users. You can set an EmailMessage template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
    
    Parameters:
    
    emailMessage - The template for email messages that Amazon Cognito sends to your users. You can set an EmailMessage template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
  - getEmailMessage
```
public String getEmailMessage()
```
    The template for email messages that Amazon Cognito sends to your users. You can set an EmailMessage template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
    
    Returns:
    
    The template for email messages that Amazon Cognito sends to your users. You can set an EmailMessage template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
  - withEmailMessage
```
public VerificationMessageTemplateType withEmailMessage(String emailMessage)
```
    The template for email messages that Amazon Cognito sends to your users. You can set an EmailMessage template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
    
    Parameters:
    
    emailMessage - The template for email messages that Amazon Cognito sends to your users. You can set an EmailMessage template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEmailSubject
```
public void setEmailSubject(String emailSubject)
```
    The subject line for the email message template. You can set an EmailSubject template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
    
    Parameters:
    
    emailSubject - The subject line for the email message template. You can set an EmailSubject template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
  - getEmailSubject
```
public String getEmailSubject()
```
    The subject line for the email message template. You can set an EmailSubject template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
    
    Returns:
    
    The subject line for the email message template. You can set an EmailSubject template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
  - withEmailSubject
```
public VerificationMessageTemplateType withEmailSubject(String emailSubject)
```
    The subject line for the email message template. You can set an EmailSubject template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
    
    Parameters:
    
    emailSubject - The subject line for the email message template. You can set an EmailSubject template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEmailMessageByLink
```
public void setEmailMessageByLink(String emailMessageByLink)
```
    The email message template for sending a confirmation link to the user. You can set an EmailMessageByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
    
    Parameters:
    
    emailMessageByLink - The email message template for sending a confirmation link to the user. You can set an EmailMessageByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
  - getEmailMessageByLink
```
public String getEmailMessageByLink()
```
    The email message template for sending a confirmation link to the user. You can set an EmailMessageByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
    
    Returns:
    
    The email message template for sending a confirmation link to the user. You can set an EmailMessageByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
  - withEmailMessageByLink
```
public VerificationMessageTemplateType withEmailMessageByLink(String emailMessageByLink)
```
    The email message template for sending a confirmation link to the user. You can set an EmailMessageByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
    
    Parameters:
    
    emailMessageByLink - The email message template for sending a confirmation link to the user. You can set an EmailMessageByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEmailSubjectByLink
```
public void setEmailSubjectByLink(String emailSubjectByLink)
```
    The subject line for the email message template for sending a confirmation link to the user. You can set an EmailSubjectByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
    
    Parameters:
    
    emailSubjectByLink - The subject line for the email message template for sending a confirmation link to the user. You can set an EmailSubjectByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
  - getEmailSubjectByLink
```
public String getEmailSubjectByLink()
```
    The subject line for the email message template for sending a confirmation link to the user. You can set an EmailSubjectByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
    
    Returns:
    
    The subject line for the email message template for sending a confirmation link to the user. You can set an EmailSubjectByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
  - withEmailSubjectByLink
```
public VerificationMessageTemplateType withEmailSubjectByLink(String emailSubjectByLink)
```
    The subject line for the email message template for sending a confirmation link to the user. You can set an EmailSubjectByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
    
    Parameters:
    
    emailSubjectByLink - The subject line for the email message template for sending a confirmation link to the user. You can set an EmailSubjectByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDefaultEmailOption
```
public void setDefaultEmailOption(String defaultEmailOption)
```
    The default email option.
    
    Parameters:
    
    defaultEmailOption - The default email option.
    
    See Also:
    
    DefaultEmailOptionType
  - getDefaultEmailOption
```
public String getDefaultEmailOption()
```
    The default email option.
    
    Returns:
    
    The default email option.
    
    See Also:
    
    DefaultEmailOptionType
  - withDefaultEmailOption
```
public VerificationMessageTemplateType withDefaultEmailOption(String defaultEmailOption)
```
    The default email option.
    
    Parameters:
    
    defaultEmailOption - The default email option.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DefaultEmailOptionType
  - withDefaultEmailOption
```
public VerificationMessageTemplateType withDefaultEmailOption(DefaultEmailOptionType defaultEmailOption)
```
    The default email option.
    
    Parameters:
    
    defaultEmailOption - The default email option.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DefaultEmailOptionType
  - toString
```
public String toString()
```
    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.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public VerificationMessageTemplateType clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.793

Class VerificationMessageTemplateType

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

VerificationMessageTemplateType

Method Detail

setSmsMessage

getSmsMessage

withSmsMessage

setEmailMessage

getEmailMessage

withEmailMessage

setEmailSubject

getEmailSubject

withEmailSubject

setEmailMessageByLink

getEmailMessageByLink

withEmailMessageByLink

setEmailSubjectByLink

getEmailSubjectByLink

withEmailSubjectByLink

setDefaultEmailOption

getDefaultEmailOption

withDefaultEmailOption

withDefaultEmailOption

toString

equals

hashCode

clone

marshall