Package software.amazon.awscdk.services.refactorspaces

Class CfnRoute

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.refactorspaces.CfnRoute
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:34.912Z") @Stability(Stable) public class CfnRoute extends CfnResource implements IInspectable
A CloudFormation AWS::RefactorSpaces::Route.

Creates an AWS 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.

In the AWS::RefactorSpaces::Route resource, you can only update the ActivationState property, which resides under the UriPathRoute and DefaultRoute properties. All other properties associated with the AWS::RefactorSpaces::Route cannot be updated, even though the property description might indicate otherwise. Updating all other properties will result in the replacement of Route.

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

  • URL Endpoints

If the service has a URL endpoint, and the endpoint resolves to a private IP address, Refactor Spaces routes traffic using the API Gateway VPC link. If a service endpoint resolves to a public IP address, Refactor Spaces routes traffic over the public internet. 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.

Refactor Spaces automatically resolves the public Domain Name System (DNS) names that are set in CreateService:UrlEndpoint when you create a service. The DNS names resolve when the DNS time-to-live (TTL) expires, or every 60 seconds for TTLs less than 60 seconds. This periodic DNS resolution ensures that the route configuration remains up-to-date.

One-time health check

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 private URLs, a target group is created on the Network Load Balancer and the load balancer target group runs default target health checks. By default, the health check is run against the service endpoint URL. Optionally, the health check can be performed against a different protocol, port, and/or path using the CreateService:UrlEndpoint parameter. All other health check settings for the load balancer use the default values described in the Health checks for your target groups in the Elastic Load Balancing guide . The health check is considered successful if at least one target within the target group transitions to a healthy state.

  • AWS Lambda function endpoints

If the service has an AWS Lambda function endpoint, then Refactor Spaces configures the Lambda function's resource policy to allow the application's API Gateway to invoke the function.

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 AWS Lambda Developer Guide .

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.

Environments without a network bridge

When you create environments without a network bridge ( CreateEnvironment:NetworkFabricType is NONE) and you use your own networking infrastructure, you need to configure VPC to VPC connectivity between your network and the application proxy VPC. Route creation from the application proxy to service endpoints will fail if your network is not configured to connect to the application proxy VPC. For more information, see Create a route in the Refactor Spaces User Guide .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.refactorspaces.*;
 CfnRoute cfnRoute = CfnRoute.Builder.create(this, "MyCfnRoute")
         .applicationIdentifier("applicationIdentifier")
         .environmentIdentifier("environmentIdentifier")
         .routeType("routeType")
         .serviceIdentifier("serviceIdentifier")
         // the properties below are optional
         .defaultRoute(DefaultRouteInputProperty.builder()
                 .activationState("activationState")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .uriPathRoute(UriPathRouteInputProperty.builder()
                 .activationState("activationState")
                 // the properties below are optional
                 .appendSourcePath(false)
                 .includeChildPaths(false)
                 .methods(List.of("methods"))
                 .sourcePath("sourcePath")
                 .build())
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnRoute

      protected CfnRoute(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnRoute

      protected CfnRoute(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnRoute

      @Stability(Stable) public CfnRoute(@NotNull Construct scope, @NotNull String id, @NotNull CfnRouteProps props)
      Create a new AWS::RefactorSpaces::Route.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the route.

    • getAttrPathResourceToId

      @Stability(Stable) @NotNull public String getAttrPathResourceToId()
      A mapping of Amazon API Gateway path resources to resource IDs.

    • getAttrRouteIdentifier

      @Stability(Stable) @NotNull public String getAttrRouteIdentifier()
      The unique identifier of the route.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      The tags assigned to the route.

    • getApplicationIdentifier

      @Stability(Stable) @NotNull public String getApplicationIdentifier()
      The unique identifier of the application.

    • setApplicationIdentifier

      @Stability(Stable) public void setApplicationIdentifier(@NotNull String value)
      The unique identifier of the application.

    • getEnvironmentIdentifier

      @Stability(Stable) @NotNull public String getEnvironmentIdentifier()
      The unique identifier of the environment.

    • setEnvironmentIdentifier

      @Stability(Stable) public void setEnvironmentIdentifier(@NotNull String value)
      The unique identifier of the environment.

    • getRouteType

      @Stability(Stable) @NotNull public String getRouteType()
      The route type of the route.

    • setRouteType

      @Stability(Stable) public void setRouteType(@NotNull String value)
      The route type of the route.

    • getServiceIdentifier

      @Stability(Stable) @NotNull public String getServiceIdentifier()
      The unique identifier of the service.

    • setServiceIdentifier

      @Stability(Stable) public void setServiceIdentifier(@NotNull String value)
      The unique identifier of the service.

    • getDefaultRoute

      @Stability(Stable) @Nullable public Object getDefaultRoute()
      Configuration for the default route type.

    • setDefaultRoute

      @Stability(Stable) public void setDefaultRoute(@Nullable IResolvable value)
      Configuration for the default route type.

    • setDefaultRoute

      @Stability(Stable) public void setDefaultRoute(@Nullable CfnRoute.DefaultRouteInputProperty value)
      Configuration for the default route type.

    • getUriPathRoute

      @Stability(Stable) @Nullable public Object getUriPathRoute()
      The configuration for the URI path route type.

    • setUriPathRoute

      @Stability(Stable) public void setUriPathRoute(@Nullable IResolvable value)
      The configuration for the URI path route type.

    • setUriPathRoute

      @Stability(Stable) public void setUriPathRoute(@Nullable CfnRoute.UriPathRouteInputProperty value)
      The configuration for the URI path route type.