Struct aws_sdk_apigatewayv2::client::fluent_builders::CreateRoute

pub struct CreateRoute { /* private fields */ }

Fluent builder constructing a request to CreateRoute.

Creates a Route for an API.

Implementations

impl CreateRoute

pub async fn send(self) -> Result<CreateRouteOutput, SdkError<CreateRouteError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn api_id(self, input: impl Into<String>) -> Self

The API identifier.

pub fn set_api_id(self, input: Option<String>) -> Self

The API identifier.

pub fn api_key_required(self, input: bool) -> Self

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

pub fn set_api_key_required(self, input: Option<bool>) -> Self

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

pub fn authorization_scopes(self, input: impl Into<String>) -> Self

Appends an item to AuthorizationScopes.

To override the contents of this collection use set_authorization_scopes.

The authorization scopes supported by this route.

pub fn set_authorization_scopes(self, input: Option<Vec<String>>) -> Self

The authorization scopes supported by this route.

pub fn authorization_type(self, input: AuthorizationType) -> Self

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 set_authorization_type(self, input: Option<AuthorizationType>) -> Self

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, input: impl Into<String>) -> Self

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 set_authorizer_id(self, input: Option<String>) -> Self

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, input: impl Into<String>) -> Self

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

pub fn set_model_selection_expression(self, input: Option<String>) -> Self

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

pub fn operation_name(self, input: impl Into<String>) -> Self

The operation name for the route.

pub fn set_operation_name(self, input: Option<String>) -> Self

The operation name for the route.

pub fn request_models(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to RequestModels.

To override the contents of this collection use set_request_models.

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

pub fn set_request_models(self, input: Option<HashMap<String, String>>) -> Self

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

pub fn request_parameters(
    self,
    k: impl Into<String>,
    v: ParameterConstraints
) -> Self

Adds a key-value pair to RequestParameters.

To override the contents of this collection use set_request_parameters.

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

pub fn set_request_parameters(
    self,
    input: Option<HashMap<String, ParameterConstraints>>
) -> Self

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

pub fn route_key(self, input: impl Into<String>) -> Self

The route key for the route.

pub fn set_route_key(self, input: Option<String>) -> Self

The route key for the route.

pub fn route_response_selection_expression(
    self,
    input: impl Into<String>
) -> Self

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

pub fn set_route_response_selection_expression(
    self,
    input: Option<String>
) -> Self

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

pub fn target(self, input: impl Into<String>) -> Self

The target for the route.

pub fn set_target(self, input: Option<String>) -> Self

The target for the route.

Trait Implementations

impl Clone for CreateRoute

fn clone(&self) -> CreateRoute

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateRoute

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

Formats the value using the given formatter.