2.170.0

interface RedirectOptions

LanguageType name
.NETAmazon.CDK.AWS.ElasticLoadBalancingV2.RedirectOptions
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awselasticloadbalancingv2#RedirectOptions
Javasoftware.amazon.awscdk.services.elasticloadbalancingv2.RedirectOptions
Pythonaws_cdk.aws_elasticloadbalancingv2.RedirectOptions
TypeScript (source)aws-cdk-lib » aws_elasticloadbalancingv2 » RedirectOptions

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 { aws_elasticloadbalancingv2 as elbv2 } from 'aws-cdk-lib';
const redirectOptions: elbv2.RedirectOptions = {
  host: 'host',
  path: 'path',
  permanent: false,
  port: 'port',
  protocol: 'protocol',
  query: 'query',
};

Properties

NameTypeDescription
host?stringThe hostname.
path?stringThe absolute path, starting with the leading "/".
permanent?booleanThe HTTP redirect code.
port?stringThe port.
protocol?stringThe protocol.
query?stringThe query parameters, URL-encoded when necessary, but not percent-encoded.

host?

Type: string (optional, default: No change)

The hostname.

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

path?

Type: string (optional, default: No change)

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

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

permanent?

Type: boolean (optional, default: false)

The HTTP redirect code.

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

port?

Type: string (optional, default: No change)

The port.

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

protocol?

Type: string (optional, default: No change)

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.

query?

Type: string (optional, default: No change)

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.

← PreviousNext →