Interface SendNotifyCodeVerificationRequest.Builder

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

  • Method Details

    • channel

      SendNotifyCodeVerificationRequest.Builder channel(String channel)

      The channel used to deliver the one-time passcode to the recipient.

      Parameters:
      channel - The channel used to deliver the one-time passcode to the recipient.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • channel

      SendNotifyCodeVerificationRequest.Builder channel(NotifyChannel channel)

      The channel used to deliver the one-time passcode to the recipient.

      Parameters:
      channel - The channel used to deliver the one-time passcode to the recipient.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • destinationIdentity

      SendNotifyCodeVerificationRequest.Builder destinationIdentity(String destinationIdentity)

      The recipient identifier. For the TEXT and VOICE channels, specify an E.164 phone number. For the WhatsApp channel, specify a WhatsApp address.

      Parameters:
      destinationIdentity - The recipient identifier. For the TEXT and VOICE channels, specify an E.164 phone number. For the WhatsApp channel, specify a WhatsApp address.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • originationIdentity

      SendNotifyCodeVerificationRequest.Builder originationIdentity(String originationIdentity)

      The identity used to send the message, such as a phone number, sender ID, or pool that is owned by your account.

      Parameters:
      originationIdentity - The identity used to send the message, such as a phone number, sender ID, or pool that is owned by your account.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • notifyCodeConfiguration

      SendNotifyCodeVerificationRequest.Builder notifyCodeConfiguration(String notifyCodeConfiguration)

      The identifier or Amazon Resource Name (ARN) of the notify code configuration that supplies the passcode policy and template defaults. When you do not specify a configuration, you must supply the template in the request.

      Parameters:
      notifyCodeConfiguration - The identifier or Amazon Resource Name (ARN) of the notify code configuration that supplies the passcode policy and template defaults. When you do not specify a configuration, you must supply the template in the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideChannelParameters

      SendNotifyCodeVerificationRequest.Builder overrideChannelParameters(ChannelParameters overrideChannelParameters)

      The channel-specific parameters used to render and deliver the one-time passcode for this request. The route that is derived from the channel and the origination identity selects the matching channel. When you do not specify channel parameters, the service uses the parameters from the referenced notify code configuration.

      Parameters:
      overrideChannelParameters - The channel-specific parameters used to render and deliver the one-time passcode for this request. The route that is derived from the channel and the origination identity selects the matching channel. When you do not specify channel parameters, the service uses the parameters from the referenced notify code configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideChannelParameters

      default SendNotifyCodeVerificationRequest.Builder overrideChannelParameters(Consumer<ChannelParameters.Builder> overrideChannelParameters)

      The channel-specific parameters used to render and deliver the one-time passcode for this request. The route that is derived from the channel and the origination identity selects the matching channel. When you do not specify channel parameters, the service uses the parameters from the referenced notify code configuration.

      This is a convenience method that creates an instance of the ChannelParameters.Builder avoiding the need to create one manually via ChannelParameters.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to overrideChannelParameters(ChannelParameters).

      Parameters:
      overrideChannelParameters - a consumer that will call methods on ChannelParameters.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideCodeConfigurationParameters

      SendNotifyCodeVerificationRequest.Builder overrideCodeConfigurationParameters(CodeConfigurationParameters overrideCodeConfigurationParameters)

      The per-send overrides for the passcode policy parameters, including the code type, length, validity period, and maximum number of attempts. These values override the values from the referenced notify code configuration. When you do not specify a value, the value from the configuration is used, and if neither is set, the service default applies.

      Parameters:
      overrideCodeConfigurationParameters - The per-send overrides for the passcode policy parameters, including the code type, length, validity period, and maximum number of attempts. These values override the values from the referenced notify code configuration. When you do not specify a value, the value from the configuration is used, and if neither is set, the service default applies.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideCodeConfigurationParameters

      default SendNotifyCodeVerificationRequest.Builder overrideCodeConfigurationParameters(Consumer<CodeConfigurationParameters.Builder> overrideCodeConfigurationParameters)

      The per-send overrides for the passcode policy parameters, including the code type, length, validity period, and maximum number of attempts. These values override the values from the referenced notify code configuration. When you do not specify a value, the value from the configuration is used, and if neither is set, the service default applies.

      This is a convenience method that creates an instance of the CodeConfigurationParameters.Builder avoiding the need to create one manually via CodeConfigurationParameters.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to overrideCodeConfigurationParameters(CodeConfigurationParameters).

      Parameters:
      overrideCodeConfigurationParameters - a consumer that will call methods on CodeConfigurationParameters.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • configurationSetName

      SendNotifyCodeVerificationRequest.Builder configurationSetName(String configurationSetName)

      The name of the configuration set used to control how delivery events for the message are handled.

      Parameters:
      configurationSetName - The name of the configuration set used to control how delivery events for the message are handled.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • context

      SendNotifyCodeVerificationRequest.Builder context(Map<String,String> context)

      A map of custom key and value pairs that are propagated to the delivery events for this verification.

      Parameters:
      context - A map of custom key and value pairs that are propagated to the delivery events for this verification.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • referenceId

      SendNotifyCodeVerificationRequest.Builder referenceId(String referenceId)

      A caller-supplied reference identifier that binds a send request to a later validate request. Specify the same value in both requests.

      Parameters:
      referenceId - A caller-supplied reference identifier that binds a send request to a later validate request. Specify the same value in both requests.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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