class CfnRoutePropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.RefactorSpaces.Mixins.CfnRoutePropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsrefactorspaces/mixins#CfnRoutePropsMixin
Java	software.amazon.awscdk.mixins.preview.services.refactorspaces.mixins.CfnRoutePropsMixin
Python	aws_cdk.mixins_preview.aws_refactorspaces.mixins.CfnRoutePropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_refactorspaces » mixins » CfnRoutePropsMixin

Implements IMixin

Extends Mixin

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 ABPlong 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 ABP 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 ELB 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 ABP 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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-route.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as refactorspaces_mixins } from '@aws-cdk/mixins-preview/aws-refactorspaces';
const cfnRoutePropsMixin = new refactorspaces_mixins.CfnRoutePropsMixin({
  applicationIdentifier: 'applicationIdentifier',
  defaultRoute: {
    activationState: 'activationState',
  },
  environmentIdentifier: 'environmentIdentifier',
  routeType: 'routeType',
  serviceIdentifier: 'serviceIdentifier',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  uriPathRoute: {
    activationState: 'activationState',
    appendSourcePath: false,
    includeChildPaths: false,
    methods: ['methods'],
    sourcePath: 'sourcePath',
  },
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnRoutePropsMixin(props: CfnRouteMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnRouteMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::RefactorSpaces::Route.

Properties

Name	Type	Description
props	CfnRouteMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnRouteMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.