#[non_exhaustive]pub struct CreateRouteOutputBuilder { /* private fields */ }
Expand description
A builder for CreateRouteOutput
.
Implementations§
Source§impl CreateRouteOutputBuilder
impl CreateRouteOutputBuilder
Sourcepub fn api_gateway_managed(self, input: bool) -> Self
pub fn api_gateway_managed(self, input: bool) -> Self
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.
Sourcepub fn set_api_gateway_managed(self, input: Option<bool>) -> Self
pub fn set_api_gateway_managed(self, input: Option<bool>) -> Self
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.
Sourcepub fn get_api_gateway_managed(&self) -> &Option<bool>
pub fn get_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.
Sourcepub fn api_key_required(self, input: bool) -> Self
pub fn api_key_required(self, input: bool) -> Self
Specifies whether an API key is required for this route. Supported only for WebSocket APIs.
Sourcepub fn set_api_key_required(self, input: Option<bool>) -> Self
pub fn set_api_key_required(self, input: Option<bool>) -> Self
Specifies whether an API key is required for this route. Supported only for WebSocket APIs.
Sourcepub fn get_api_key_required(&self) -> &Option<bool>
pub fn get_api_key_required(&self) -> &Option<bool>
Specifies whether an API key is required for this route. Supported only for WebSocket APIs.
Appends an item to authorization_scopes
.
To override the contents of this collection use set_authorization_scopes
.
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.
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.
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.
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.
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.
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.
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.
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.
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.
Sourcepub fn model_selection_expression(self, input: impl Into<String>) -> Self
pub fn model_selection_expression(self, input: impl Into<String>) -> Self
The model selection expression for the route. Supported only for WebSocket APIs.
Sourcepub fn set_model_selection_expression(self, input: Option<String>) -> Self
pub fn set_model_selection_expression(self, input: Option<String>) -> Self
The model selection expression for the route. Supported only for WebSocket APIs.
Sourcepub fn get_model_selection_expression(&self) -> &Option<String>
pub fn get_model_selection_expression(&self) -> &Option<String>
The model selection expression for the route. Supported only for WebSocket APIs.
Sourcepub fn operation_name(self, input: impl Into<String>) -> Self
pub fn operation_name(self, input: impl Into<String>) -> Self
The operation name for the route.
Sourcepub fn set_operation_name(self, input: Option<String>) -> Self
pub fn set_operation_name(self, input: Option<String>) -> Self
The operation name for the route.
Sourcepub fn get_operation_name(&self) -> &Option<String>
pub fn get_operation_name(&self) -> &Option<String>
The operation name for the route.
Sourcepub fn request_models(self, k: impl Into<String>, v: impl Into<String>) -> Self
pub fn request_models(self, k: impl Into<String>, v: impl Into<String>) -> Self
Adds a key-value pair to request_models
.
To override the contents of this collection use set_request_models
.
The request models for the route. Supported only for WebSocket APIs.
Sourcepub fn set_request_models(self, input: Option<HashMap<String, String>>) -> Self
pub fn set_request_models(self, input: Option<HashMap<String, String>>) -> Self
The request models for the route. Supported only for WebSocket APIs.
Sourcepub fn get_request_models(&self) -> &Option<HashMap<String, String>>
pub fn get_request_models(&self) -> &Option<HashMap<String, String>>
The request models for the route. Supported only for WebSocket APIs.
Sourcepub fn request_parameters(
self,
k: impl Into<String>,
v: ParameterConstraints,
) -> Self
pub fn request_parameters( self, k: impl Into<String>, v: ParameterConstraints, ) -> Self
Adds a key-value pair to request_parameters
.
To override the contents of this collection use set_request_parameters
.
The request parameters for the route. Supported only for WebSocket APIs.
Sourcepub fn set_request_parameters(
self,
input: Option<HashMap<String, ParameterConstraints>>,
) -> Self
pub fn set_request_parameters( self, input: Option<HashMap<String, ParameterConstraints>>, ) -> Self
The request parameters for the route. Supported only for WebSocket APIs.
Sourcepub fn get_request_parameters(
&self,
) -> &Option<HashMap<String, ParameterConstraints>>
pub fn get_request_parameters( &self, ) -> &Option<HashMap<String, ParameterConstraints>>
The request parameters for the route. Supported only for WebSocket APIs.
Sourcepub fn set_route_id(self, input: Option<String>) -> Self
pub fn set_route_id(self, input: Option<String>) -> Self
The route ID.
Sourcepub fn get_route_id(&self) -> &Option<String>
pub fn get_route_id(&self) -> &Option<String>
The route ID.
Sourcepub fn set_route_key(self, input: Option<String>) -> Self
pub fn set_route_key(self, input: Option<String>) -> Self
The route key for the route.
Sourcepub fn get_route_key(&self) -> &Option<String>
pub fn get_route_key(&self) -> &Option<String>
The route key for the route.
Sourcepub fn route_response_selection_expression(
self,
input: impl Into<String>,
) -> Self
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.
Sourcepub fn set_route_response_selection_expression(
self,
input: Option<String>,
) -> Self
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.
Sourcepub fn get_route_response_selection_expression(&self) -> &Option<String>
pub fn get_route_response_selection_expression(&self) -> &Option<String>
The route response selection expression for the route. Supported only for WebSocket APIs.
Sourcepub fn set_target(self, input: Option<String>) -> Self
pub fn set_target(self, input: Option<String>) -> Self
The target for the route.
Sourcepub fn get_target(&self) -> &Option<String>
pub fn get_target(&self) -> &Option<String>
The target for the route.
Sourcepub fn build(self) -> CreateRouteOutput
pub fn build(self) -> CreateRouteOutput
Consumes the builder and constructs a CreateRouteOutput
.
Trait Implementations§
Source§impl Clone for CreateRouteOutputBuilder
impl Clone for CreateRouteOutputBuilder
Source§fn clone(&self) -> CreateRouteOutputBuilder
fn clone(&self) -> CreateRouteOutputBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for CreateRouteOutputBuilder
impl Debug for CreateRouteOutputBuilder
Source§impl Default for CreateRouteOutputBuilder
impl Default for CreateRouteOutputBuilder
Source§fn default() -> CreateRouteOutputBuilder
fn default() -> CreateRouteOutputBuilder
Source§impl PartialEq for CreateRouteOutputBuilder
impl PartialEq for CreateRouteOutputBuilder
Source§fn eq(&self, other: &CreateRouteOutputBuilder) -> bool
fn eq(&self, other: &CreateRouteOutputBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for CreateRouteOutputBuilder
Auto Trait Implementations§
impl Freeze for CreateRouteOutputBuilder
impl RefUnwindSafe for CreateRouteOutputBuilder
impl Send for CreateRouteOutputBuilder
impl Sync for CreateRouteOutputBuilder
impl Unpin for CreateRouteOutputBuilder
impl UnwindSafe for CreateRouteOutputBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);