aws_sdk_migrationhubrefactorspaces/client/

create_route.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateRoute`](crate::operation::create_route::builders::CreateRouteFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`environment_identifier(impl Into<String>)`](crate::operation::create_route::builders::CreateRouteFluentBuilder::environment_identifier) / [`set_environment_identifier(Option<String>)`](crate::operation::create_route::builders::CreateRouteFluentBuilder::set_environment_identifier):<br>required: **true**<br><p>The ID of the environment in which the route is created.</p><br>
    ///   - [`application_identifier(impl Into<String>)`](crate::operation::create_route::builders::CreateRouteFluentBuilder::application_identifier) / [`set_application_identifier(Option<String>)`](crate::operation::create_route::builders::CreateRouteFluentBuilder::set_application_identifier):<br>required: **true**<br><p>The ID of the application within which the route is being created.</p><br>
    ///   - [`service_identifier(impl Into<String>)`](crate::operation::create_route::builders::CreateRouteFluentBuilder::service_identifier) / [`set_service_identifier(Option<String>)`](crate::operation::create_route::builders::CreateRouteFluentBuilder::set_service_identifier):<br>required: **true**<br><p>The ID of the service in which the route is created. Traffic that matches this route is forwarded to this service.</p><br>
    ///   - [`route_type(RouteType)`](crate::operation::create_route::builders::CreateRouteFluentBuilder::route_type) / [`set_route_type(Option<RouteType>)`](crate::operation::create_route::builders::CreateRouteFluentBuilder::set_route_type):<br>required: **true**<br><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><br>
    ///   - [`default_route(DefaultRouteInput)`](crate::operation::create_route::builders::CreateRouteFluentBuilder::default_route) / [`set_default_route(Option<DefaultRouteInput>)`](crate::operation::create_route::builders::CreateRouteFluentBuilder::set_default_route):<br>required: **false**<br><p>Configuration for the default route type.</p><br>
    ///   - [`uri_path_route(UriPathRouteInput)`](crate::operation::create_route::builders::CreateRouteFluentBuilder::uri_path_route) / [`set_uri_path_route(Option<UriPathRouteInput>)`](crate::operation::create_route::builders::CreateRouteFluentBuilder::set_uri_path_route):<br>required: **false**<br><p>The configuration for the URI path route type.</p><br>
    ///   - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::create_route::builders::CreateRouteFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::create_route::builders::CreateRouteFluentBuilder::set_tags):<br>required: **false**<br><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><br>
    ///   - [`client_token(impl Into<String>)`](crate::operation::create_route::builders::CreateRouteFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::create_route::builders::CreateRouteFluentBuilder::set_client_token):<br>required: **false**<br><p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p><br>
    /// - On success, responds with [`CreateRouteOutput`](crate::operation::create_route::CreateRouteOutput) with field(s):
    ///   - [`route_id(Option<String>)`](crate::operation::create_route::CreateRouteOutput::route_id): <p>The unique identifier of the route.</p>
    ///   - [`arn(Option<String>)`](crate::operation::create_route::CreateRouteOutput::arn): <p>The Amazon Resource Name (ARN) of the route. The format for this ARN is <code>arn:aws:refactor-spaces:<i>region</i>:<i>account-id</i>:<i>resource-type/resource-id</i> </code>. For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html"> Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>.</p>
    ///   - [`owner_account_id(Option<String>)`](crate::operation::create_route::CreateRouteOutput::owner_account_id): <p>The Amazon Web Services account ID of the route owner.</p>
    ///   - [`created_by_account_id(Option<String>)`](crate::operation::create_route::CreateRouteOutput::created_by_account_id): <p>The Amazon Web Services account ID of the route creator.</p>
    ///   - [`route_type(Option<RouteType>)`](crate::operation::create_route::CreateRouteOutput::route_type): <p>The route type of the route.</p>
    ///   - [`service_id(Option<String>)`](crate::operation::create_route::CreateRouteOutput::service_id): <p>The ID of service in which the route is created. Traffic that matches this route is forwarded to this service.</p>
    ///   - [`application_id(Option<String>)`](crate::operation::create_route::CreateRouteOutput::application_id): <p>The ID of the application in which the route is created.</p>
    ///   - [`uri_path_route(Option<UriPathRouteInput>)`](crate::operation::create_route::CreateRouteOutput::uri_path_route): <p>Configuration for the URI path route type.</p>
    ///   - [`state(Option<RouteState>)`](crate::operation::create_route::CreateRouteOutput::state): <p>The current state of the route. Activation state only allows <code>ACTIVE</code> or <code>INACTIVE</code> as user inputs. <code>FAILED</code> is a route state that is system generated.</p>
    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::create_route::CreateRouteOutput::tags): <p>The tags assigned to the created route. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair.</p>
    ///   - [`last_updated_time(Option<DateTime>)`](crate::operation::create_route::CreateRouteOutput::last_updated_time): <p>A timestamp that indicates when the route was last updated.</p>
    ///   - [`created_time(Option<DateTime>)`](crate::operation::create_route::CreateRouteOutput::created_time): <p>A timestamp that indicates when the route is created.</p>
    /// - On failure, responds with [`SdkError<CreateRouteError>`](crate::operation::create_route::CreateRouteError)
    pub fn create_route(&self) -> crate::operation::create_route::builders::CreateRouteFluentBuilder {
        crate::operation::create_route::builders::CreateRouteFluentBuilder::new(self.handle.clone())
    }
}