1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct UpdateRouteOutput {
/// <p>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.</p>
pub api_gateway_managed: ::std::option::Option<bool>,
/// <p>Specifies whether an API key is required for this route. Supported only for WebSocket APIs.</p>
pub api_key_required: ::std::option::Option<bool>,
/// <p>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.</p>
pub authorization_scopes: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
/// <p>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.</p>
pub authorization_type: ::std::option::Option<crate::types::AuthorizationType>,
/// <p>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.</p>
pub authorizer_id: ::std::option::Option<::std::string::String>,
/// <p>The model selection expression for the route. Supported only for WebSocket APIs.</p>
pub model_selection_expression: ::std::option::Option<::std::string::String>,
/// <p>The operation name for the route.</p>
pub operation_name: ::std::option::Option<::std::string::String>,
/// <p>The request models for the route. Supported only for WebSocket APIs.</p>
pub request_models: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
/// <p>The request parameters for the route. Supported only for WebSocket APIs.</p>
pub request_parameters: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::ParameterConstraints>>,
/// <p>The route ID.</p>
pub route_id: ::std::option::Option<::std::string::String>,
/// <p>The route key for the route.</p>
pub route_key: ::std::option::Option<::std::string::String>,
/// <p>The route response selection expression for the route. Supported only for WebSocket APIs.</p>
pub route_response_selection_expression: ::std::option::Option<::std::string::String>,
/// <p>The target for the route.</p>
pub target: ::std::option::Option<::std::string::String>,
_request_id: Option<String>,
}
impl UpdateRouteOutput {
/// <p>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.</p>
pub fn api_gateway_managed(&self) -> ::std::option::Option<bool> {
self.api_gateway_managed
}
/// <p>Specifies whether an API key is required for this route. Supported only for WebSocket APIs.</p>
pub fn api_key_required(&self) -> ::std::option::Option<bool> {
self.api_key_required
}
/// <p>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.</p>
///
/// 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_scopes(&self) -> &[::std::string::String] {
self.authorization_scopes.as_deref().unwrap_or_default()
}
/// <p>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.</p>
pub fn authorization_type(&self) -> ::std::option::Option<&crate::types::AuthorizationType> {
self.authorization_type.as_ref()
}
/// <p>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.</p>
pub fn authorizer_id(&self) -> ::std::option::Option<&str> {
self.authorizer_id.as_deref()
}
/// <p>The model selection expression for the route. Supported only for WebSocket APIs.</p>
pub fn model_selection_expression(&self) -> ::std::option::Option<&str> {
self.model_selection_expression.as_deref()
}
/// <p>The operation name for the route.</p>
pub fn operation_name(&self) -> ::std::option::Option<&str> {
self.operation_name.as_deref()
}
/// <p>The request models for the route. Supported only for WebSocket APIs.</p>
pub fn request_models(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, ::std::string::String>> {
self.request_models.as_ref()
}
/// <p>The request parameters for the route. Supported only for WebSocket APIs.</p>
pub fn request_parameters(
&self,
) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, crate::types::ParameterConstraints>> {
self.request_parameters.as_ref()
}
/// <p>The route ID.</p>
pub fn route_id(&self) -> ::std::option::Option<&str> {
self.route_id.as_deref()
}
/// <p>The route key for the route.</p>
pub fn route_key(&self) -> ::std::option::Option<&str> {
self.route_key.as_deref()
}
/// <p>The route response selection expression for the route. Supported only for WebSocket APIs.</p>
pub fn route_response_selection_expression(&self) -> ::std::option::Option<&str> {
self.route_response_selection_expression.as_deref()
}
/// <p>The target for the route.</p>
pub fn target(&self) -> ::std::option::Option<&str> {
self.target.as_deref()
}
}
impl ::aws_types::request_id::RequestId for UpdateRouteOutput {
fn request_id(&self) -> Option<&str> {
self._request_id.as_deref()
}
}
impl UpdateRouteOutput {
/// Creates a new builder-style object to manufacture [`UpdateRouteOutput`](crate::operation::update_route::UpdateRouteOutput).
pub fn builder() -> crate::operation::update_route::builders::UpdateRouteOutputBuilder {
crate::operation::update_route::builders::UpdateRouteOutputBuilder::default()
}
}
/// A builder for [`UpdateRouteOutput`](crate::operation::update_route::UpdateRouteOutput).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
pub struct UpdateRouteOutputBuilder {
pub(crate) api_gateway_managed: ::std::option::Option<bool>,
pub(crate) api_key_required: ::std::option::Option<bool>,
pub(crate) authorization_scopes: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
pub(crate) authorization_type: ::std::option::Option<crate::types::AuthorizationType>,
pub(crate) authorizer_id: ::std::option::Option<::std::string::String>,
pub(crate) model_selection_expression: ::std::option::Option<::std::string::String>,
pub(crate) operation_name: ::std::option::Option<::std::string::String>,
pub(crate) request_models: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
pub(crate) request_parameters: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::ParameterConstraints>>,
pub(crate) route_id: ::std::option::Option<::std::string::String>,
pub(crate) route_key: ::std::option::Option<::std::string::String>,
pub(crate) route_response_selection_expression: ::std::option::Option<::std::string::String>,
pub(crate) target: ::std::option::Option<::std::string::String>,
_request_id: Option<String>,
}
impl UpdateRouteOutputBuilder {
/// <p>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.</p>
pub fn api_gateway_managed(mut self, input: bool) -> Self {
self.api_gateway_managed = ::std::option::Option::Some(input);
self
}
/// <p>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.</p>
pub fn set_api_gateway_managed(mut self, input: ::std::option::Option<bool>) -> Self {
self.api_gateway_managed = input;
self
}
/// <p>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.</p>
pub fn get_api_gateway_managed(&self) -> &::std::option::Option<bool> {
&self.api_gateway_managed
}
/// <p>Specifies whether an API key is required for this route. Supported only for WebSocket APIs.</p>
pub fn api_key_required(mut self, input: bool) -> Self {
self.api_key_required = ::std::option::Option::Some(input);
self
}
/// <p>Specifies whether an API key is required for this route. Supported only for WebSocket APIs.</p>
pub fn set_api_key_required(mut self, input: ::std::option::Option<bool>) -> Self {
self.api_key_required = input;
self
}
/// <p>Specifies whether an API key is required for this route. Supported only for WebSocket APIs.</p>
pub fn get_api_key_required(&self) -> &::std::option::Option<bool> {
&self.api_key_required
}
/// Appends an item to `authorization_scopes`.
///
/// To override the contents of this collection use [`set_authorization_scopes`](Self::set_authorization_scopes).
///
/// <p>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.</p>
pub fn authorization_scopes(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
let mut v = self.authorization_scopes.unwrap_or_default();
v.push(input.into());
self.authorization_scopes = ::std::option::Option::Some(v);
self
}
/// <p>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.</p>
pub fn set_authorization_scopes(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.authorization_scopes = input;
self
}
/// <p>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.</p>
pub fn get_authorization_scopes(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
&self.authorization_scopes
}
/// <p>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.</p>
pub fn authorization_type(mut self, input: crate::types::AuthorizationType) -> Self {
self.authorization_type = ::std::option::Option::Some(input);
self
}
/// <p>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.</p>
pub fn set_authorization_type(mut self, input: ::std::option::Option<crate::types::AuthorizationType>) -> Self {
self.authorization_type = input;
self
}
/// <p>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.</p>
pub fn get_authorization_type(&self) -> &::std::option::Option<crate::types::AuthorizationType> {
&self.authorization_type
}
/// <p>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.</p>
pub fn authorizer_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.authorizer_id = ::std::option::Option::Some(input.into());
self
}
/// <p>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.</p>
pub fn set_authorizer_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.authorizer_id = input;
self
}
/// <p>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.</p>
pub fn get_authorizer_id(&self) -> &::std::option::Option<::std::string::String> {
&self.authorizer_id
}
/// <p>The model selection expression for the route. Supported only for WebSocket APIs.</p>
pub fn model_selection_expression(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.model_selection_expression = ::std::option::Option::Some(input.into());
self
}
/// <p>The model selection expression for the route. Supported only for WebSocket APIs.</p>
pub fn set_model_selection_expression(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.model_selection_expression = input;
self
}
/// <p>The model selection expression for the route. Supported only for WebSocket APIs.</p>
pub fn get_model_selection_expression(&self) -> &::std::option::Option<::std::string::String> {
&self.model_selection_expression
}
/// <p>The operation name for the route.</p>
pub fn operation_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.operation_name = ::std::option::Option::Some(input.into());
self
}
/// <p>The operation name for the route.</p>
pub fn set_operation_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.operation_name = input;
self
}
/// <p>The operation name for the route.</p>
pub fn get_operation_name(&self) -> &::std::option::Option<::std::string::String> {
&self.operation_name
}
/// Adds a key-value pair to `request_models`.
///
/// To override the contents of this collection use [`set_request_models`](Self::set_request_models).
///
/// <p>The request models for the route. Supported only for WebSocket APIs.</p>
pub fn request_models(
mut self,
k: impl ::std::convert::Into<::std::string::String>,
v: impl ::std::convert::Into<::std::string::String>,
) -> Self {
let mut hash_map = self.request_models.unwrap_or_default();
hash_map.insert(k.into(), v.into());
self.request_models = ::std::option::Option::Some(hash_map);
self
}
/// <p>The request models for the route. Supported only for WebSocket APIs.</p>
pub fn set_request_models(
mut self,
input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
) -> Self {
self.request_models = input;
self
}
/// <p>The request models for the route. Supported only for WebSocket APIs.</p>
pub fn get_request_models(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
&self.request_models
}
/// Adds a key-value pair to `request_parameters`.
///
/// To override the contents of this collection use [`set_request_parameters`](Self::set_request_parameters).
///
/// <p>The request parameters for the route. Supported only for WebSocket APIs.</p>
pub fn request_parameters(mut self, k: impl ::std::convert::Into<::std::string::String>, v: crate::types::ParameterConstraints) -> Self {
let mut hash_map = self.request_parameters.unwrap_or_default();
hash_map.insert(k.into(), v);
self.request_parameters = ::std::option::Option::Some(hash_map);
self
}
/// <p>The request parameters for the route. Supported only for WebSocket APIs.</p>
pub fn set_request_parameters(
mut self,
input: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::ParameterConstraints>>,
) -> Self {
self.request_parameters = input;
self
}
/// <p>The request parameters for the route. Supported only for WebSocket APIs.</p>
pub fn get_request_parameters(
&self,
) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::ParameterConstraints>> {
&self.request_parameters
}
/// <p>The route ID.</p>
pub fn route_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.route_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The route ID.</p>
pub fn set_route_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.route_id = input;
self
}
/// <p>The route ID.</p>
pub fn get_route_id(&self) -> &::std::option::Option<::std::string::String> {
&self.route_id
}
/// <p>The route key for the route.</p>
pub fn route_key(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.route_key = ::std::option::Option::Some(input.into());
self
}
/// <p>The route key for the route.</p>
pub fn set_route_key(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.route_key = input;
self
}
/// <p>The route key for the route.</p>
pub fn get_route_key(&self) -> &::std::option::Option<::std::string::String> {
&self.route_key
}
/// <p>The route response selection expression for the route. Supported only for WebSocket APIs.</p>
pub fn route_response_selection_expression(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.route_response_selection_expression = ::std::option::Option::Some(input.into());
self
}
/// <p>The route response selection expression for the route. Supported only for WebSocket APIs.</p>
pub fn set_route_response_selection_expression(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.route_response_selection_expression = input;
self
}
/// <p>The route response selection expression for the route. Supported only for WebSocket APIs.</p>
pub fn get_route_response_selection_expression(&self) -> &::std::option::Option<::std::string::String> {
&self.route_response_selection_expression
}
/// <p>The target for the route.</p>
pub fn target(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.target = ::std::option::Option::Some(input.into());
self
}
/// <p>The target for the route.</p>
pub fn set_target(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.target = input;
self
}
/// <p>The target for the route.</p>
pub fn get_target(&self) -> &::std::option::Option<::std::string::String> {
&self.target
}
pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
self._request_id = Some(request_id.into());
self
}
pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
self._request_id = request_id;
self
}
/// Consumes the builder and constructs a [`UpdateRouteOutput`](crate::operation::update_route::UpdateRouteOutput).
pub fn build(self) -> crate::operation::update_route::UpdateRouteOutput {
crate::operation::update_route::UpdateRouteOutput {
api_gateway_managed: self.api_gateway_managed,
api_key_required: self.api_key_required,
authorization_scopes: self.authorization_scopes,
authorization_type: self.authorization_type,
authorizer_id: self.authorizer_id,
model_selection_expression: self.model_selection_expression,
operation_name: self.operation_name,
request_models: self.request_models,
request_parameters: self.request_parameters,
route_id: self.route_id,
route_key: self.route_key,
route_response_selection_expression: self.route_response_selection_expression,
target: self.target,
_request_id: self._request_id,
}
}
}