AWS::RefactorSpaces::Route

Creates an Amazon Migration Hub Refactor Spaces route. The account owner of the service resource is always the environment owner, regardless of which account creates the route. Routes target a service in the application. If an application does not have any routes, then the first route must be created as a DEFAULT RouteType.

When created, the default route defaults to an active state so state is not a required input. However, like all other state values the state of the default route can be updated after creation, but only when all other routes are also inactive. Conversely, no route can be active without the default route also being active.

When you create a route, Refactor Spaces configures the Amazon API Gateway to send traffic to the target service as follows:

A one-time health check is performed on the service when either the route is updated from inactive to active, or when it is created with an active state. If the health check fails, the route transitions the route state to FAILED, an error code of SERVICE_ENDPOINT_HEALTH_CHECK_FAILURE is provided, and no traffic is sent to the service.

For Lambda functions, the Lambda function state is checked. If the function is not active, the function configuration is updated so that Lambda resources are provisioned. If the Lambda state is Failed, then the route creation fails. For more information, see the GetFunctionConfiguration's State response parameter in the Amazon Lambda Developer Guide.

For Lambda endpoints, a check is performed to determine that a Lambda function with the specified ARN exists. If it does not exist, the health check fails. For public URLs, a connection is opened to the public endpoint. If the URL is not reachable, the health check fails.

For private URLS, a target group is created on the Elastic Load Balancing and the target group health check is run. The HealthCheckProtocol, HealthCheckPort, and HealthCheckPath are the same protocol, port, and path specified in the URL or health URL, if used. All other settings use the default values, as described in Health checks for your target groups. The health check is considered successful if at least one target within the target group transitions to a healthy state.

Services can have HTTP or HTTPS URL endpoints. For HTTPS URLs, publicly-signed certificates are supported. Private Certificate Authorities (CAs) are permitted only if the CA's domain is also publicly resolvable.

Syntax

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

{
  "Type" : "AWS::RefactorSpaces::Route",
  "Properties" : {
      "ApplicationIdentifier" : String,
      "DefaultRoute" : DefaultRouteInput,
      "EnvironmentIdentifier" : String,
      "RouteType" : String,
      "ServiceIdentifier" : String,
      "Tags" : [ Tag, ... ],
      "UriPathRoute" : UriPathRouteInput
    }
}

Type: AWS::RefactorSpaces::Route
Properties: 
  ApplicationIdentifier: String
  DefaultRoute: 
    DefaultRouteInput
  EnvironmentIdentifier: String
  RouteType: String
  ServiceIdentifier: String
  Tags: 
    - Tag
  UriPathRoute: 
    UriPathRouteInput

Properties

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns a composite ID following this format: <EnvironmentId>|<ApplicationId>|<RouteId>, for example, env-1234654123|app-1234654123|rte-1234654123.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.