Skip to content

CreateRouteRequest

Source code in docs_src/capo_migration_hub_refactor_spaces/types/create_route_request.py
class CreateRouteRequest(TypedDict, closed=True):
    environment_identifier: (
        "capo_migration_hub_refactor_spaces.types.environment_id.EnvironmentId"
    )
    """<p>The ID of the environment in which the route is created.</p>"""
    application_identifier: (
        "capo_migration_hub_refactor_spaces.types.application_id.ApplicationId"
    )
    """<p>The ID of the application within which the route is being created.</p>"""
    service_identifier: "capo_migration_hub_refactor_spaces.types.service_id.ServiceId"
    """<p>The ID of the service in which the route is created. Traffic that matches this route is forwarded to this service.</p>"""
    route_type: "capo_migration_hub_refactor_spaces.types.route_type.RouteType"
    """<p>The route type of the route. <code>DEFAULT</code> indicates that all traffic that does not match another route is forwarded to the default route. Applications must have a default route before any other routes can be created. <code>URI_PATH</code> indicates a route that is based on a URI path.</p>"""
    default_route: NotRequired[
        "capo_migration_hub_refactor_spaces.types.default_route_input.DefaultRouteInput"
    ]
    """<p> Configuration for the default route type. </p>"""
    uri_path_route: NotRequired[
        "capo_migration_hub_refactor_spaces.types.uri_path_route_input.UriPathRouteInput"
    ]
    """<p>The configuration for the URI path route type. </p>"""
    tags: NotRequired["capo_migration_hub_refactor_spaces.types.tag_map.TagMap"]
    """<p>The tags to assign to the route. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair.. </p>"""
    client_token: NotRequired[
        "capo_migration_hub_refactor_spaces.types.client_token.ClientToken"
    ]
    """<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>"""

application_identifier instance-attribute

application_identifier: ApplicationId

The ID of the application within which the route is being created.

client_token instance-attribute

client_token: NotRequired[ClientToken]

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

default_route instance-attribute

default_route: NotRequired[DefaultRouteInput]

Configuration for the default route type.

environment_identifier instance-attribute

environment_identifier: EnvironmentId

The ID of the environment in which the route is created.

route_type instance-attribute

route_type: RouteType

The route type of the route. DEFAULT indicates that all traffic that does not match another route is forwarded to the default route. Applications must have a default route before any other routes can be created. URI_PATH indicates a route that is based on a URI path.

service_identifier instance-attribute

service_identifier: ServiceId

The ID of the service in which the route is created. Traffic that matches this route is forwarded to this service.

tags instance-attribute

tags: NotRequired[TagMap]

The tags to assign to the route. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair..

uri_path_route instance-attribute

uri_path_route: NotRequired[UriPathRouteInput]

The configuration for the URI path route type.