Struct aws_sdk_migrationhubrefactorspaces::client::fluent_builders::CreateRoute

pub struct CreateRoute { /* private fields */ }

Fluent builder constructing a request to CreateRoute.

Creates an Amazon Web Services 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.

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

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

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

For Lambda endpoints, 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.

Refactor Spaces automatically resolves the public Domain Name System (DNS) names that are set in CreateServiceRequest$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.

For private URLS, a target group is created on the Elastic Load Balancing and the target group health check is run. The HealthCheckProtocol, HealthCheckPort, and HealthCheckPath are the same protocol, port, and path specified in the URL or health URL, if used. All other settings use the default values, as described in Health checks for your target groups. The health check is considered successful if at least one target within the target group transitions to a healthy state.

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.

Implementations

impl CreateRoute

pub async fn customize(
    self
) -> Result<CustomizableOperation<CreateRoute, AwsResponseRetryClassifier>, SdkError<CreateRouteError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(self) -> Result<CreateRouteOutput, SdkError<CreateRouteError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn environment_identifier(self, input: impl Into<String>) -> Self

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

pub fn set_environment_identifier(self, input: Option<String>) -> Self

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

pub fn application_identifier(self, input: impl Into<String>) -> Self

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

pub fn set_application_identifier(self, input: Option<String>) -> Self

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

pub fn service_identifier(self, input: impl Into<String>) -> Self

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

pub fn set_service_identifier(self, input: Option<String>) -> Self

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

pub fn route_type(self, input: RouteType) -> Self

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.

pub fn set_route_type(self, input: Option<RouteType>) -> Self

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.

pub fn default_route(self, input: DefaultRouteInput) -> Self

Configuration for the default route type.

pub fn set_default_route(self, input: Option<DefaultRouteInput>) -> Self

Configuration for the default route type.

pub fn uri_path_route(self, input: UriPathRouteInput) -> Self

The configuration for the URI path route type.

pub fn set_uri_path_route(self, input: Option<UriPathRouteInput>) -> Self

The configuration for the URI path route type.

pub fn tags(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to Tags.

To override the contents of this collection use set_tags.

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

pub fn set_tags(self, input: Option<HashMap<String, String>>) -> Self

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

pub fn client_token(self, input: impl Into<String>) -> Self

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

pub fn set_client_token(self, input: Option<String>) -> Self

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

Trait Implementations

impl Clone for CreateRoute

fn clone(&self) -> CreateRoute

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateRoute

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.