Class CfnListenerRule.RedirectConfigProperty
Information about a redirect action.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.ElasticLoadBalancingV2
Assembly: Amazon.CDK.AWS.ElasticLoadBalancingV2.dll
Syntax (csharp)
public class RedirectConfigProperty : Object, CfnListenerRule.IRedirectConfigProperty
Syntax (vb)
Public Class RedirectConfigProperty
Inherits Object
Implements CfnListenerRule.IRedirectConfigProperty
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 redirectConfigProperty = new RedirectConfigProperty {
StatusCode = "statusCode",
// the properties below are optional
Host = "host",
Path = "path",
Port = "port",
Protocol = "protocol",
Query = "query"
};
Synopsis
Constructors
RedirectConfigProperty() |
Properties
Host | The hostname. |
Path | The absolute path, starting with the leading "/". |
Port | The port. |
Protocol | The protocol. |
Query | The query parameters, URL-encoded when necessary, but not percent-encoded. |
StatusCode | The HTTP redirect code. |
Constructors
RedirectConfigProperty()
public RedirectConfigProperty()
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}.
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}.
Port
The port.
public string Port { get; set; }
Property Value
System.String
Remarks
You can specify a value from 1 to 65535 or #{port}.
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.
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.
StatusCode
The HTTP redirect code.
public string StatusCode { get; set; }
Property Value
System.String
Remarks
The redirect is either permanent (HTTP 301) or temporary (HTTP 302).