Interface CfnRoute.UriPathRouteInputProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnRoute.UriPathRouteInputProperty extends
The configuration for the URI path route type.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 UriPathRouteInputProperty uriPathRouteInputProperty = UriPathRouteInputProperty.builder()
         // the properties below are optional
  • Method Details

    • getActivationState

      @Stability(Stable) @NotNull String getActivationState()
      If set to ACTIVE , traffic is forwarded to this route’s service after the route is created.
    • getAppendSourcePath

      @Stability(Stable) @Nullable default Object getAppendSourcePath()
      If set to true , this option appends the source path to the service URL endpoint.
    • getIncludeChildPaths

      @Stability(Stable) @Nullable default Object getIncludeChildPaths()
      Indicates whether to match all subpaths of the given source path.

      If this value is false , requests must match the source path exactly before they are forwarded to this route's service.

    • getMethods

      @Stability(Stable) @Nullable default List<String> getMethods()
      A list of HTTP methods to match.

      An empty list matches all values. If a method is present, only HTTP requests using that method are forwarded to this route’s service.

    • getSourcePath

      @Stability(Stable) @Nullable default String getSourcePath()
      This is the path that Refactor Spaces uses to match traffic.

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

    • builder

      @Stability(Stable) static CfnRoute.UriPathRouteInputProperty.Builder builder()
      a CfnRoute.UriPathRouteInputProperty.Builder of CfnRoute.UriPathRouteInputProperty