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

Interface VerificationMessageTemplateType.Builder

    • Method Detail

      • smsMessage

        VerificationMessageTemplateType.Builder smsMessage​(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.

      • emailMessage

        VerificationMessageTemplateType.Builder emailMessage​(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.

      • emailSubject

        VerificationMessageTemplateType.Builder emailSubject​(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.

      • emailMessageByLink

        VerificationMessageTemplateType.Builder emailMessageByLink​(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.

      • emailSubjectByLink

        VerificationMessageTemplateType.Builder emailSubjectByLink​(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.

      • defaultEmailOption

        VerificationMessageTemplateType.Builder defaultEmailOption​(String defaultEmailOption)

        The configuration of verification emails to contain a clickable link or a verification code.

        For link, your template body must contain link text in the format {##Click here##}. "Click here" in the example is a customizable string. For code, your template body must contain a code placeholder in the format {####}.

        Parameters:
        defaultEmailOption - The configuration of verification emails to contain a clickable link or a verification code.

        For link, your template body must contain link text in the format {##Click here##}. "Click here" in the example is a customizable string. For code, your template body must contain a code placeholder in the format {####}.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DefaultEmailOptionType, DefaultEmailOptionType

      • defaultEmailOption

        VerificationMessageTemplateType.Builder defaultEmailOption​(DefaultEmailOptionType defaultEmailOption)

        The configuration of verification emails to contain a clickable link or a verification code.

        For link, your template body must contain link text in the format {##Click here##}. "Click here" in the example is a customizable string. For code, your template body must contain a code placeholder in the format {####}.

        Parameters:
        defaultEmailOption - The configuration of verification emails to contain a clickable link or a verification code.

        For link, your template body must contain link text in the format {##Click here##}. "Click here" in the example is a customizable string. For code, your template body must contain a code placeholder in the format {####}.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DefaultEmailOptionType, DefaultEmailOptionType