pub struct UpdateAuthorizerResponse {
pub authorizer_credentials_arn: Option<String>,
pub authorizer_id: Option<String>,
pub authorizer_payload_format_version: Option<String>,
pub authorizer_result_ttl_in_seconds: Option<i64>,
pub authorizer_type: Option<String>,
pub authorizer_uri: Option<String>,
pub enable_simple_responses: Option<bool>,
pub identity_source: Option<Vec<String>>,
pub identity_validation_expression: Option<String>,
pub jwt_configuration: Option<JWTConfiguration>,
pub name: Option<String>,
}
Fields
Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.
The authorizer identifier.
Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.
The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).
The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:
enable_simple_responses: Option<bool>
Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs
identity_source: Option<Vec<String>>
The identity source for which authorization is requested.
For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.
identity_validation_expression: Option<String>
The validation expression does not apply to the REQUEST authorizer.
jwt_configuration: Option<JWTConfiguration>
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
name: Option<String>
The name of the authorizer.
Trait Implementations
sourceimpl Clone for UpdateAuthorizerResponse
impl Clone for UpdateAuthorizerResponse
sourcefn clone(&self) -> UpdateAuthorizerResponse
fn clone(&self) -> UpdateAuthorizerResponse
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for UpdateAuthorizerResponse
impl Debug for UpdateAuthorizerResponse
sourceimpl Default for UpdateAuthorizerResponse
impl Default for UpdateAuthorizerResponse
sourcefn default() -> UpdateAuthorizerResponse
fn default() -> UpdateAuthorizerResponse
Returns the “default value” for a type. Read more
sourceimpl<'de> Deserialize<'de> for UpdateAuthorizerResponse
impl<'de> Deserialize<'de> for UpdateAuthorizerResponse
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl PartialEq<UpdateAuthorizerResponse> for UpdateAuthorizerResponse
impl PartialEq<UpdateAuthorizerResponse> for UpdateAuthorizerResponse
sourcefn eq(&self, other: &UpdateAuthorizerResponse) -> bool
fn eq(&self, other: &UpdateAuthorizerResponse) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &UpdateAuthorizerResponse) -> bool
fn ne(&self, other: &UpdateAuthorizerResponse) -> bool
This method tests for !=
.
impl StructuralPartialEq for UpdateAuthorizerResponse
Auto Trait Implementations
impl RefUnwindSafe for UpdateAuthorizerResponse
impl Send for UpdateAuthorizerResponse
impl Sync for UpdateAuthorizerResponse
impl Unpin for UpdateAuthorizerResponse
impl UnwindSafe for UpdateAuthorizerResponse
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more