Struct aws_sdk_apigatewayv2::operation::create_route::CreateRouteInput

#[non_exhaustive]
pub struct CreateRouteInput {
    pub api_id: Option<String>,
    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_key: Option<String>,
    pub route_response_selection_expression: Option<String>,
    pub target: Option<String>,
}

Creates a new Route resource to represent a route.

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_id: Option<String>

The API identifier.

api_key_required: Option<bool>

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

authorization_scopes: Option<Vec<String>>

The authorization scopes supported by this route.

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_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 CreateRouteInput

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

The API identifier.

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

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

pub fn authorization_scopes(&self) -> &[String]

The authorization scopes supported by this route.

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_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 CreateRouteInput

pub fn builder() -> CreateRouteInputBuilder

Creates a new builder-style object to manufacture CreateRouteInput.

Trait Implementations

impl Clone for CreateRouteInput

fn clone(&self) -> CreateRouteInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateRouteInput

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

Formats the value using the given formatter.

impl PartialEq for CreateRouteInput

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