CfnRoutePropsMixin

class aws_cdk.mixins_preview.aws_refactorspaces.mixins.CfnRoutePropsMixin(props, *, strategy=None)

Bases: 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. .. epigraph:

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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-route.html
CloudformationResource:: AWS::RefactorSpaces::Route
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_refactorspaces import mixins as refactorspaces_mixins

cfn_route_props_mixin = refactorspaces_mixins.CfnRoutePropsMixin(refactorspaces_mixins.CfnRouteMixinProps(
    application_identifier="applicationIdentifier",
    default_route=refactorspaces_mixins.CfnRoutePropsMixin.DefaultRouteInputProperty(
        activation_state="activationState"
    ),
    environment_identifier="environmentIdentifier",
    route_type="routeType",
    service_identifier="serviceIdentifier",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    uri_path_route=refactorspaces_mixins.CfnRoutePropsMixin.UriPathRouteInputProperty(
        activation_state="activationState",
        append_source_path=False,
        include_child_paths=False,
        methods=["methods"],
        source_path="sourcePath"
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnRouteMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['applicationIdentifier', 'defaultRoute', 'environmentIdentifier', 'routeType', 'serviceIdentifier', 'tags', 'uriPathRoute']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

DefaultRouteInputProperty

class CfnRoutePropsMixin.DefaultRouteInputProperty(*, activation_state=None)

Bases: object

The configuration for the default route type.

Parameters:: activation_state (Optional[str]) – If set to ACTIVE , traffic is forwarded to this route’s service after the route is created.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-refactorspaces-route-defaultrouteinput.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_refactorspaces import mixins as refactorspaces_mixins

default_route_input_property = refactorspaces_mixins.CfnRoutePropsMixin.DefaultRouteInputProperty(
    activation_state="activationState"
)

Attributes

activation_state

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-refactorspaces-route-defaultrouteinput.html#cfn-refactorspaces-route-defaultrouteinput-activationstate

UriPathRouteInputProperty

class CfnRoutePropsMixin.UriPathRouteInputProperty(*, activation_state=None, append_source_path=None, include_child_paths=None, methods=None, source_path=None)

Bases: object

The configuration for the URI path route type.

Parameters:

activation_state (Optional[str]) – If set to ACTIVE , traffic is forwarded to this route’s service after the route is created.
append_source_path (Union[bool, IResolvable, None]) – If set to true , this option appends the source path to the service URL endpoint.
include_child_paths (Union[bool, IResolvable, None]) – 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.
methods (Optional[Sequence[str]]) – 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.
source_path (Optional[str]) – 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’.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-refactorspaces-route-uripathrouteinput.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_refactorspaces import mixins as refactorspaces_mixins

uri_path_route_input_property = refactorspaces_mixins.CfnRoutePropsMixin.UriPathRouteInputProperty(
    activation_state="activationState",
    append_source_path=False,
    include_child_paths=False,
    methods=["methods"],
    source_path="sourcePath"
)

Attributes

activation_state

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-refactorspaces-route-uripathrouteinput.html#cfn-refactorspaces-route-uripathrouteinput-activationstate

append_source_path

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-refactorspaces-route-uripathrouteinput.html#cfn-refactorspaces-route-uripathrouteinput-appendsourcepath

include_child_paths

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-refactorspaces-route-uripathrouteinput.html#cfn-refactorspaces-route-uripathrouteinput-includechildpaths

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-refactorspaces-route-uripathrouteinput.html#cfn-refactorspaces-route-uripathrouteinput-methods

source_path

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-refactorspaces-route-uripathrouteinput.html#cfn-refactorspaces-route-uripathrouteinput-sourcepath