Class RedirectOptions

Options for ListenerAction.redirect().

Inheritance

System.Object

RedirectOptions

Implements

IRedirectOptions

Namespace: Amazon.CDK.AWS.ElasticLoadBalancingV2

Assembly: Amazon.CDK.AWS.ElasticLoadBalancingV2.dll

Syntax (csharp)

public class RedirectOptions : Object, IRedirectOptions

Syntax (vb)

Public Class RedirectOptions
    Inherits Object
    Implements IRedirectOptions

Remarks

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:

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ElasticLoadBalancingV2;

var redirectOptions = new RedirectOptions {
    Host = "host",
    Path = "path",
    Permanent = false,
    Port = "port",
    Protocol = "protocol",
    Query = "query"
};

Synopsis

Constructors

RedirectOptions()

Properties

Host	The hostname.
Path	The absolute path, starting with the leading "/".
Permanent	The HTTP redirect code.
Port	The port.
Protocol	The protocol.
Query	The query parameters, URL-encoded when necessary, but not percent-encoded.

Constructors

RedirectOptions()

public RedirectOptions()

Properties

Host

The hostname.

public string Host { get; set; }

Property Value

System.String

Remarks

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

Default: - No change

Path

The absolute path, starting with the leading "/".

public string Path { get; set; }

Property Value

System.String

Remarks

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

Default: - No change

Permanent

The HTTP redirect code.

public Nullable<bool> Permanent { get; set; }

Property Value

System.Nullable<System.Boolean>

Remarks

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

Default: false

Port

The port.

public string Port { get; set; }

Property Value

System.String

Remarks

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

Default: - No change

Protocol

The protocol.

public string Protocol { get; set; }

Property Value

System.String

Remarks

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

Query

The query parameters, URL-encoded when necessary, but not percent-encoded.

public string Query { get; set; }

Property Value

System.String

Remarks

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

Default: - No change

Implements

IRedirectOptions