Struct aws_sdk_apigatewayv2::operation::get_route::GetRouteOutput

#[non_exhaustive]
pub struct GetRouteOutput {

    pub api_gateway_managed: Option<bool>,
    pub api_key_required: Option<bool>,
    pub authorization_scopes: Option<Vec<String>>,
    pub authorization_type: Option<AuthorizationType>,
    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>,
    /* private fields */
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

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

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.

Implementations

impl GetRouteOutput

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

pub fn api_key_required(&self) -> Option<bool>

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

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .authorization_scopes.is_none().

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 GetRouteOutput

pub fn builder() -> GetRouteOutputBuilder

Creates a new builder-style object to manufacture GetRouteOutput.

Trait Implementations

impl Clone for GetRouteOutput

fn clone(&self) -> GetRouteOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetRouteOutput

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

Formats the value using the given formatter.

impl PartialEq for GetRouteOutput

fn eq(&self, other: &GetRouteOutput) -> 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 RequestId for GetRouteOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for GetRouteOutput