#[non_exhaustive]pub struct UpdateAuthorizerInput {
pub api_id: Option<String>,
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<i32>,
pub authorizer_type: Option<AuthorizerType>,
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>,
}
Expand description
Updates an Authorizer.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.api_id: Option<String>
The API identifier.
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.
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. By default, a Lambda authorizer must return an IAM policy. 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>
This parameter is not used.
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.
Implementations§
source§impl UpdateAuthorizerInput
impl UpdateAuthorizerInput
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.
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:
sourcepub fn enable_simple_responses(&self) -> Option<bool>
pub fn enable_simple_responses(&self) -> Option<bool>
Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. 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
sourcepub fn identity_source(&self) -> &[String]
pub fn identity_source(&self) -> &[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.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .identity_source.is_none()
.
sourcepub fn identity_validation_expression(&self) -> Option<&str>
pub fn identity_validation_expression(&self) -> Option<&str>
This parameter is not used.
sourcepub fn jwt_configuration(&self) -> Option<&JwtConfiguration>
pub fn jwt_configuration(&self) -> Option<&JwtConfiguration>
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
source§impl UpdateAuthorizerInput
impl UpdateAuthorizerInput
sourcepub fn builder() -> UpdateAuthorizerInputBuilder
pub fn builder() -> UpdateAuthorizerInputBuilder
Creates a new builder-style object to manufacture UpdateAuthorizerInput
.
Trait Implementations§
source§impl Clone for UpdateAuthorizerInput
impl Clone for UpdateAuthorizerInput
source§fn clone(&self) -> UpdateAuthorizerInput
fn clone(&self) -> UpdateAuthorizerInput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for UpdateAuthorizerInput
impl Debug for UpdateAuthorizerInput
source§impl PartialEq for UpdateAuthorizerInput
impl PartialEq for UpdateAuthorizerInput
source§fn eq(&self, other: &UpdateAuthorizerInput) -> bool
fn eq(&self, other: &UpdateAuthorizerInput) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for UpdateAuthorizerInput
Auto Trait Implementations§
impl Freeze for UpdateAuthorizerInput
impl RefUnwindSafe for UpdateAuthorizerInput
impl Send for UpdateAuthorizerInput
impl Sync for UpdateAuthorizerInput
impl Unpin for UpdateAuthorizerInput
impl UnwindSafe for UpdateAuthorizerInput
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> 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 more