logo
pub struct CreateRouteResult {
Show 13 fields pub api_gateway_managed: Option<bool>, pub api_key_required: Option<bool>, pub authorization_scopes: Option<Vec<String>>, pub authorization_type: Option<String>, pub authorizer_id: Option<String>, pub model_selection_expression: Option<String>, pub operation_name: Option<String>, pub request_models: Option<HashMap<String, String>>, pub request_parameters: Option<HashMap<String, ParameterConstraints>>, pub route_id: Option<String>, pub route_key: Option<String>, pub route_response_selection_expression: Option<String>, pub target: Option<String>,
}

Fields

api_gateway_managed: Option<bool>

Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.

api_key_required: Option<bool>

Specifies whether an API key is required for this route. Supported only for WebSocket APIs.

authorization_scopes: Option<Vec<String>>

A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

authorization_type: Option<String>

The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.

authorizer_id: Option<String>

The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.

model_selection_expression: Option<String>

The model selection expression for the route. Supported only for WebSocket APIs.

operation_name: Option<String>

The operation name for the route.

request_models: Option<HashMap<String, String>>

The request models for the route. Supported only for WebSocket APIs.

request_parameters: Option<HashMap<String, ParameterConstraints>>

The request parameters for the route. Supported only for WebSocket APIs.

route_id: Option<String>

The route ID.

route_key: Option<String>

The route key for the route.

route_response_selection_expression: Option<String>

The route response selection expression for the route. Supported only for WebSocket APIs.

target: Option<String>

The target for the route.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Returns the “default value” for a type. Read more

Deserialize this value from the given Serde deserializer. Read more

This method tests for self and other values to be equal, and is used by ==. Read more

This method tests for !=.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Should always be Self

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more