software.amazon.awscdk.services.elasticloadbalancingv2

Interface RedirectOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

RedirectOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.133Z")
 @Stability(value=Stable)
public interface RedirectOptions
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.elasticloadbalancingv2.*;
 RedirectOptions redirectOptions = RedirectOptions.builder()
         .host("host")
         .path("path")
         .permanent(false)
         .port("port")
         .protocol("protocol")
         .query("query")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RedirectOptions.Builder A builder for RedirectOptions
static class	RedirectOptions.Jsii$Proxy An implementation for RedirectOptions

Method Summary

Modifier and Type	Method and Description
static RedirectOptions.Builder	builder()
default String	getHost() The hostname.
default String	getPath() The absolute path, starting with the leading "/".
default Boolean	getPermanent() The HTTP redirect code.
default String	getPort() The port.
default String	getProtocol() The protocol.
default String	getQuery() The query parameters, URL-encoded when necessary, but not percent-encoded.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getHost

@Stability(value=Stable)
 @Nullable
default String getHost()

The hostname.

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

Default: - No change

getPath

@Stability(value=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(value=Stable)
 @Nullable
default Boolean getPermanent()

The HTTP redirect code.

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

Default: false

getPort

@Stability(value=Stable)
 @Nullable
default String getPort()

The port.

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

Default: - No change

getProtocol

@Stability(value=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(value=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(value=Stable)
static RedirectOptions.Builder builder()

Returns:

a RedirectOptions.Builder of RedirectOptions