aws_sdk_appmesh/client/
create_gateway_route.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`CreateGatewayRoute`](crate::operation::create_gateway_route::builders::CreateGatewayRouteFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`gateway_route_name(impl Into<String>)`](crate::operation::create_gateway_route::builders::CreateGatewayRouteFluentBuilder::gateway_route_name) / [`set_gateway_route_name(Option<String>)`](crate::operation::create_gateway_route::builders::CreateGatewayRouteFluentBuilder::set_gateway_route_name):<br>required: **true**<br><p>The name to use for the gateway route.</p><br>
7    ///   - [`mesh_name(impl Into<String>)`](crate::operation::create_gateway_route::builders::CreateGatewayRouteFluentBuilder::mesh_name) / [`set_mesh_name(Option<String>)`](crate::operation::create_gateway_route::builders::CreateGatewayRouteFluentBuilder::set_mesh_name):<br>required: **true**<br><p>The name of the service mesh to create the gateway route in.</p><br>
8    ///   - [`virtual_gateway_name(impl Into<String>)`](crate::operation::create_gateway_route::builders::CreateGatewayRouteFluentBuilder::virtual_gateway_name) / [`set_virtual_gateway_name(Option<String>)`](crate::operation::create_gateway_route::builders::CreateGatewayRouteFluentBuilder::set_virtual_gateway_name):<br>required: **true**<br><p>The name of the virtual gateway to associate the gateway route with. If the virtual gateway is in a shared mesh, then you must be the owner of the virtual gateway resource.</p><br>
9    ///   - [`spec(GatewayRouteSpec)`](crate::operation::create_gateway_route::builders::CreateGatewayRouteFluentBuilder::spec) / [`set_spec(Option<GatewayRouteSpec>)`](crate::operation::create_gateway_route::builders::CreateGatewayRouteFluentBuilder::set_spec):<br>required: **true**<br><p>The gateway route specification to apply.</p><br>
10    ///   - [`tags(TagRef)`](crate::operation::create_gateway_route::builders::CreateGatewayRouteFluentBuilder::tags) / [`set_tags(Option<Vec::<TagRef>>)`](crate::operation::create_gateway_route::builders::CreateGatewayRouteFluentBuilder::set_tags):<br>required: **false**<br><p>Optional metadata that you can apply to the gateway route to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.</p><br>
11    ///   - [`client_token(impl Into<String>)`](crate::operation::create_gateway_route::builders::CreateGatewayRouteFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::create_gateway_route::builders::CreateGatewayRouteFluentBuilder::set_client_token):<br>required: **false**<br><p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p><br>
12    ///   - [`mesh_owner(impl Into<String>)`](crate::operation::create_gateway_route::builders::CreateGatewayRouteFluentBuilder::mesh_owner) / [`set_mesh_owner(Option<String>)`](crate::operation::create_gateway_route::builders::CreateGatewayRouteFluentBuilder::set_mesh_owner):<br>required: **false**<br><p>The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p><br>
13    /// - On success, responds with [`CreateGatewayRouteOutput`](crate::operation::create_gateway_route::CreateGatewayRouteOutput) with field(s):
14    ///   - [`gateway_route(Option<GatewayRouteData>)`](crate::operation::create_gateway_route::CreateGatewayRouteOutput::gateway_route): <p>The full description of your gateway route following the create call.</p>
15    /// - On failure, responds with [`SdkError<CreateGatewayRouteError>`](crate::operation::create_gateway_route::CreateGatewayRouteError)
16    pub fn create_gateway_route(&self) -> crate::operation::create_gateway_route::builders::CreateGatewayRouteFluentBuilder {
17        crate::operation::create_gateway_route::builders::CreateGatewayRouteFluentBuilder::new(self.handle.clone())
18    }
19}