Interface CfnRoute.IUriPathRouteInputProperty
The configuration for the URI path route type.
Namespace: Amazon.CDK.AWS.RefactorSpaces
Assembly: Amazon.CDK.AWS.RefactorSpaces.dll
Syntax (csharp)
public interface IUriPathRouteInputProperty
Syntax (vb)
Public Interface IUriPathRouteInputProperty
Remarks
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.RefactorSpaces;
var uriPathRouteInputProperty = new UriPathRouteInputProperty {
ActivationState = "activationState",
// the properties below are optional
AppendSourcePath = false,
IncludeChildPaths = false,
Methods = new [] { "methods" },
SourcePath = "sourcePath"
};
Synopsis
Properties
ActivationState | If set to |
AppendSourcePath | If set to |
IncludeChildPaths | Indicates whether to match all subpaths of the given source path. |
Methods | A list of HTTP methods to match. |
SourcePath | This is the path that Refactor Spaces uses to match traffic. |
Properties
ActivationState
If set to ACTIVE
, traffic is forwarded to this route’s service after the route is created.
string ActivationState { get; }
Property Value
System.String
Remarks
AppendSourcePath
If set to true
, this option appends the source path to the service URL endpoint.
virtual object AppendSourcePath { get; }
Property Value
System.Object
Remarks
IncludeChildPaths
Indicates whether to match all subpaths of the given source path.
virtual object IncludeChildPaths { get; }
Property Value
System.Object
Remarks
If this value is false
, requests must match the source path exactly before they are forwarded to this route's service.
Methods
A list of HTTP methods to match.
virtual string[] Methods { get; }
Property Value
System.String[]
Remarks
An empty list matches all values. If a method is present, only HTTP requests using that method are forwarded to this route’s service.
SourcePath
This is the path that Refactor Spaces uses to match traffic.
virtual string SourcePath { get; }
Property Value
System.String
Remarks
Paths must start with /
and are relative to the base of the application. To use path parameters in the source path, add a variable in curly braces. For example, the resource path {user} represents a path parameter called 'user'.