AWS::RefactorSpaces::Route UriPathRouteInput - AWS CloudFormation
SyntaxProperties

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::RefactorSpaces::Route UriPathRouteInput

The configuration for the URI path route type.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "ActivationState" : String,
  "AppendSourcePath" : Boolean,
  "IncludeChildPaths" : Boolean,
  "Methods" : [ String, ... ],
  "SourcePath" : String
}

YAML

  ActivationState: String
  AppendSourcePath: Boolean
  IncludeChildPaths: Boolean
  Methods: 
    - String
  SourcePath: String

Properties

ActivationState

If set to ACTIVE, traffic is forwarded to this route’s service after the route is created.

Required: Yes

Type: String

Allowed values: INACTIVE | ACTIVE

Update requires: No interruption

AppendSourcePath

If set to true, this option appends the source path to the service URL endpoint.

Required: No

Type: Boolean

Update requires: Replacement

IncludeChildPaths

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.

Required: No

Type: Boolean

Update requires: Replacement

Methods

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.

Required: No

Type: Array of String

Update requires: Replacement

SourcePath

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

Required: No

Type: String

Pattern: ^(/([a-zA-Z0-9._:-]+|\{[a-zA-Z0-9._:-]+\}))+$

Minimum: 1

Maximum: 2048

Update requires: Replacement