RedirectOptions

class aws_cdk.aws_elasticloadbalancingv2.RedirectOptions(*, host=None, path=None, permanent=None, port=None, protocol=None, query=None)

Bases: object

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

Parameters:

  • host (Optional[str]) – The hostname. This component is not percent-encoded. The hostname can contain #{host}. Default: - No change

  • path (Optional[str]) – The absolute path, starting with the leading “/”. This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}. Default: - No change

  • permanent (Optional[bool]) – The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302). Default: false

  • port (Optional[str]) – The port. You can specify a value from 1 to 65535 or #{port}. Default: - No change

  • protocol (Optional[str]) – 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

  • query (Optional[str]) – 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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_elasticloadbalancingv2 as elbv2

redirect_options = elbv2.RedirectOptions(
    host="host",
    path="path",
    permanent=False,
    port="port",
    protocol="protocol",
    query="query"
)

Attributes

host

The hostname.

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

Default:

  • No change

path

The absolute path, starting with the leading “/”.

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

Default:

  • No change

permanent

The HTTP redirect code.

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

Default:

false

port

The port.

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

Default:

  • No change

protocol

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

query

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