Interface RedirectOptions

All Superinterfaces:
All Known Implementing Classes:

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:44.392Z") @Stability(Stable) public interface RedirectOptions extends
Options for ListenerAction.redirect().

A URI consists of the following components: protocol://hostname:port/path?query. You must modify at least one of the following components to avoid a redirect loop: protocol, hostname, port, or path. Any components that you do not modify retain their original values.

You can reuse URI components using the following reserved keywords:

  • #{protocol}
  • #{host}
  • #{port}
  • #{path} (the leading "/" is removed)
  • #{query}

For example, you can change the path to "/new/#{path}", the hostname to "example.#{host}", or the query to "#{query}&value=xyz".


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 RedirectOptions redirectOptions = RedirectOptions.builder()
  • Method Details

    • getHost

      @Stability(Stable) @Nullable default String getHost()
      The hostname.

      This component is not percent-encoded. The hostname can contain #{host}.

      Default: - No change

    • getPath

      @Stability(Stable) @Nullable default String getPath()
      The absolute path, starting with the leading "/".

      This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}.

      Default: - No change

    • getPermanent

      @Stability(Stable) @Nullable default Boolean getPermanent()
      The HTTP redirect code.

      The redirect is either permanent (HTTP 301) or temporary (HTTP 302).

      Default: false

    • getPort

      @Stability(Stable) @Nullable default String getPort()
      The port.

      You can specify a value from 1 to 65535 or #{port}.

      Default: - No change

    • getProtocol

      @Stability(Stable) @Nullable default String getProtocol()
      The protocol.

      You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP.

      Default: - No change

    • getQuery

      @Stability(Stable) @Nullable default String getQuery()
      The query parameters, URL-encoded when necessary, but not percent-encoded.

      Do not include the leading "?", as it is automatically added. You can specify any of the reserved keywords.

      Default: - No change

    • builder

      @Stability(Stable) static RedirectOptions.Builder builder()
      a RedirectOptions.Builder of RedirectOptions