@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-14T16:25:25.142Z") public class CfnRoute extends CfnResource implements IInspectable
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 theActivationState
property, which resides under theUriPathRoute
andDefaultRoute
properties. All other properties associated with theAWS::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:
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.
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") .serviceIdentifier("serviceIdentifier") // the properties below are optional .defaultRoute(DefaultRouteInputProperty.builder() .activationState("activationState") .build()) .routeType("routeType") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .uriPathRoute(UriPathRouteInputProperty.builder() .activationState("activationState") // the properties below are optional .includeChildPaths(false) .methods(List.of("methods")) .sourcePath("sourcePath") .build()) .build();
Modifier and Type | Class and Description |
---|---|
static class |
CfnRoute.Builder
A fluent builder for
CfnRoute . |
static interface |
CfnRoute.DefaultRouteInputProperty
The configuration for the default route type.
|
static interface |
CfnRoute.UriPathRouteInputProperty
The configuration for the URI path route type.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnRoute(Construct scope,
java.lang.String id,
CfnRouteProps props)
Create a new `AWS::RefactorSpaces::Route`.
|
protected |
CfnRoute(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnRoute(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getApplicationIdentifier()
The unique identifier of the application.
|
java.lang.String |
getAttrArn()
The Amazon Resource Name (ARN) of the route.
|
java.lang.String |
getAttrPathResourceToId()
A mapping of Amazon API Gateway path resources to resource IDs.
|
java.lang.String |
getAttrRouteIdentifier()
The unique identifier of the route.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.Object |
getDefaultRoute()
Configuration for the default route type.
|
java.lang.String |
getEnvironmentIdentifier()
The unique identifier of the environment.
|
java.lang.String |
getRouteType()
The route type of the route.
|
java.lang.String |
getServiceIdentifier()
The unique identifier of the service.
|
TagManager |
getTags()
The tags assigned to the route.
|
java.lang.Object |
getUriPathRoute()
The configuration for the URI path route type.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setApplicationIdentifier(java.lang.String value)
The unique identifier of the application.
|
void |
setDefaultRoute(CfnRoute.DefaultRouteInputProperty value)
Configuration for the default route type.
|
void |
setDefaultRoute(IResolvable value)
Configuration for the default route type.
|
void |
setEnvironmentIdentifier(java.lang.String value)
The unique identifier of the environment.
|
void |
setRouteType(java.lang.String value)
The route type of the route.
|
void |
setServiceIdentifier(java.lang.String value)
The unique identifier of the service.
|
void |
setUriPathRoute(CfnRoute.UriPathRouteInputProperty value)
The configuration for the URI path route type.
|
void |
setUriPathRoute(IResolvable value)
The configuration for the URI path route type.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnRoute(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnRoute(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnRoute(Construct scope, java.lang.String id, CfnRouteProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrArn()
public java.lang.String getAttrPathResourceToId()
public java.lang.String getAttrRouteIdentifier()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
public java.lang.String getApplicationIdentifier()
public void setApplicationIdentifier(java.lang.String value)
public java.lang.String getEnvironmentIdentifier()
public void setEnvironmentIdentifier(java.lang.String value)
public java.lang.String getServiceIdentifier()
public void setServiceIdentifier(java.lang.String value)
public java.lang.Object getDefaultRoute()
public void setDefaultRoute(IResolvable value)
public void setDefaultRoute(CfnRoute.DefaultRouteInputProperty value)
public java.lang.String getRouteType()
public void setRouteType(java.lang.String value)
public java.lang.Object getUriPathRoute()
public void setUriPathRoute(IResolvable value)
public void setUriPathRoute(CfnRoute.UriPathRouteInputProperty value)