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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb

Overview

Note:

When making an API call, you may pass RedirectActionConfig data as a 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".

Instance Attribute Summary collapse

Instance Attribute Details

#hostString

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

Returns:

  • (String)


2724
2725
2726
2727
2728
2729
2730
2731
2732
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 2724

class RedirectActionConfig < Struct.new(
  :protocol,
  :port,
  :host,
  :path,
  :query,
  :status_code)
  include Aws::Structure
end

#pathString

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

{path\}, and #{port\}.

Returns:

  • (String)


2724
2725
2726
2727
2728
2729
2730
2731
2732
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 2724

class RedirectActionConfig < Struct.new(
  :protocol,
  :port,
  :host,
  :path,
  :query,
  :status_code)
  include Aws::Structure
end

#portString

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

Returns:

  • (String)


2724
2725
2726
2727
2728
2729
2730
2731
2732
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 2724

class RedirectActionConfig < Struct.new(
  :protocol,
  :port,
  :host,
  :path,
  :query,
  :status_code)
  include Aws::Structure
end

#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)


2724
2725
2726
2727
2728
2729
2730
2731
2732
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 2724

class RedirectActionConfig < Struct.new(
  :protocol,
  :port,
  :host,
  :path,
  :query,
  :status_code)
  include Aws::Structure
end

#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)


2724
2725
2726
2727
2728
2729
2730
2731
2732
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 2724

class RedirectActionConfig < Struct.new(
  :protocol,
  :port,
  :host,
  :path,
  :query,
  :status_code)
  include Aws::Structure
end

#status_codeString

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

Returns:

  • (String)


2724
2725
2726
2727
2728
2729
2730
2731
2732
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 2724

class RedirectActionConfig < Struct.new(
  :protocol,
  :port,
  :host,
  :path,
  :query,
  :status_code)
  include Aws::Structure
end