AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::ElasticLoadBalancingV2::Types::RedirectActionConfig

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing RedirectActionConfig as input to an Aws::Client method, you can use a vanilla Hash:

{
  protocol: "RedirectActionProtocol",
  port: "RedirectActionPort",
  host: "RedirectActionHost",
  path: "RedirectActionPath",
  query: "RedirectActionQuery",
  status_code: "HTTP_301", # required, accepts HTTP_301, HTTP_302
}

Information about a redirect action.

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

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#hostString

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

Returns:

  • (String)

    The hostname.

#pathString

The absolute path, starting with the leading \"/\". This component is not percent-encoded. The path can contain #`#host`, #`#path`, and #`#port`.

Returns:

  • (String)

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

#portString

The port. You can specify a value from 1 to 65535 or #`#port`.

Returns:

  • (String)

    The port.

#protocolString

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.

Returns:

  • (String)

    The protocol.

#queryString

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.

Returns:

  • (String)

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

#status_codeString

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

Possible values:

  • HTTP_301
  • HTTP_302

Returns:

  • (String)

    The HTTP redirect code.