Struct aws_sdk_apigatewayv2::types::Route

#[non_exhaustive]
pub struct Route { /* private fields */ }

Represents a route.

Implementations

impl Route

pub fn api_gateway_managed(&self) -> 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.

pub fn api_key_required(&self) -> bool

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

pub fn authorization_scopes(&self) -> Option<&[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.

pub fn authorization_type(&self) -> Option<&AuthorizationType>

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.

pub fn authorizer_id(&self) -> Option<&str>

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.

pub fn model_selection_expression(&self) -> Option<&str>

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

pub fn operation_name(&self) -> Option<&str>

The operation name for the route.

pub fn request_models(&self) -> Option<&HashMap<String, String>>

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

pub fn request_parameters( &self ) -> Option<&HashMap<String, ParameterConstraints>>

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

pub fn route_id(&self) -> Option<&str>

The route ID.

pub fn route_key(&self) -> Option<&str>

The route key for the route.

pub fn route_response_selection_expression(&self) -> Option<&str>

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

pub fn target(&self) -> Option<&str>

The target for the route.

impl Route

pub fn builder() -> RouteBuilder

Creates a new builder-style object to manufacture Route.

Trait Implementations

impl Clone for Route

fn clone(&self) -> Route

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Route

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

Formats the value using the given formatter.

impl PartialEq<Route> for Route

fn eq(&self, other: &Route) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Route